doc: update docs
This commit is contained in:
Michael Yang
parent
7cd0b10865
commit
9002dd6aa8
Binary file not shown.
|
After Width: | Height: | Size: 146 KiB |
104
readme.md
104
readme.md
|
|
@ -1,57 +1,85 @@
|
|||
<h4 align="right"><strong>English</strong> | <a href="./readme.zh.md">简体中文</a></h4>
|
||||
<h4 align="right"><a href="./readme.md">English</a> | <strong>简体中文</strong></h4>
|
||||
|
||||
|
||||
|
||||
[//]: # ()
|
||||
|
||||
# AiEditor
|
||||
<div style="text-align: center">
|
||||
|
||||
About AiEditor (official website https://aieditor.dev)
|
||||
<img src="./docs/assets/image/logo.png" style="width: 100px">
|
||||
|
||||
> AiEditor is a next-generation rich text editor for AI.
|
||||
> It is based on Web Component and therefore supports almost any front-end framework
|
||||
> such as Vue, React, Angular and Svelte. It is adapted to PC Web and mobile, and provides two themes: light and dark.
|
||||
> In addition, it also provides flexible configuration, developers can easily use it to develop any text editing application.
|
||||
# AIEditor.dev
|
||||
|
||||
## Live Demo
|
||||
## An AI-Powered rich text editor
|
||||
|
||||
Out-of-the-box, Fully Framework Supported, Markdown Friendly
|
||||
|
||||
<img src="./docs/assets/image/index-banner.png" style="width: 90%">
|
||||
|
||||
</div>
|
||||
|
||||
## Start following and using AIEditor
|
||||
|
||||
Give us a star so that you can be notified in time when we release new versions.
|
||||
|
||||
<img src="./docs/assets/image/star.gif" style="width: 90%">
|
||||
|
||||
|
||||
## What is AIEditor
|
||||
|
||||
AiEditor is a next-generation rich text editor for AI. It is based on Web Component and supports almost any front-end framework such as Vue, React, Angular, etc. It is compatible with PC Web
|
||||
and mobiles, and provides two themes: light and dark. In addition, it also provides flexible configuration, and developers can easily use it to develop any text editing application.
|
||||
|
||||
For more information about AiEditor, please visit the official website: https://aieditor.dev
|
||||
|
||||
|
||||
## What makes AIEditor different
|
||||
|
||||
### 1. AI-Powered editor
|
||||
The goal of AIEditor is to create a rich text editor that is completely driven by AI, and supports docking with any large model, including private large models. Allow users to use their own private large model ApiKey.
|
||||
Not only that, all AI functions of AIEditor allow users to customize their own prompts and extended AI menus.
|
||||
|
||||
### 2. Simple, friendly, and easy to use
|
||||
|
||||
AIEditor is developed based on Web Component and supports integration with any mainstream front-end framework. AIEditor uses the more friendly LGPL open source protocol and is used through `npm i aieditor`,
|
||||
without worrying about the GPL infection problem that may be caused by the GPL protocol.
|
||||
|
||||
### 3. In addition to the open source version, a commercial version is also available
|
||||
In addition to the open source version, we also provide a more powerful commercial version, which does not limit the number of users or the number of applications. For more comparisons of commercial versions,
|
||||
please refer to here: https://aieditor.dev/versions.html
|
||||
|
||||
|
||||
## Online Demo
|
||||
|
||||
- Classic/traditional style: https://aieditor.dev/demo.html
|
||||
- Modern style: http://aieditor1.jpress.cn
|
||||
- Classic Style: http://aieditor.jpress.cn
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Completed
|
||||
|
||||
- [x] **Basics**: Heading, Paragraph, Font, FontSize, FontColor, bold, italics, underline, strikethrough, link, inline code, superscript, subscript, dividing line, quotation, printing
|
||||
- [x] **Enhancements**: undo, redo, format painter, eraser(clear format), to-do list, background color, Emoji, alignment, line height, (un)ordered list, paragraph indent, force break
|
||||
- [x] **Attachments**: Supports image, video, and file functions, supports selection upload, paste upload, drag upload, drag resize...
|
||||
- [x] **Code**: inline code, code blocks, code language selection, **AI comments**, **AI explain**...
|
||||
- [x] **Table**: increase left or right, decrease left or right, increase up or down, decrease up or down, merge cells, unmerge
|
||||
- [x] **Markdown**: heading, quotes, tables, pictures, code blocks, **custom container(vuepress:::)**, lists, bold, italics, strikethrough...
|
||||
- [x] **A I**: AI continuation, AI optimization, AI proofreading, AI translation, custom AI menu and its prompts
|
||||
- [x] **More**: i18n, light theme, dark theme, mobile adaptation, full-screen, @someone (mentioned)...
|
||||
- [x] **Basics**: Title, body, font, font size, bold, italic, underline, strikethrough, link, inline code, superscript, subscript, dividing line, quote, print
|
||||
- [x] **Enhanced**: Undo, Redo, Format brush, Eraser, To-do list, font color, background color, Emoji expression, alignment, line height, ordered (unordered) list, paragraph indent, forced line break
|
||||
- [x] **Attachment**: Supports image, video, file functions, supports select upload, paste upload, drag upload, support drag resize...
|
||||
- [x] **Code**: Inline code, code block, language type selection, **AI automatic comment**, **AI code explanation**...
|
||||
- [x] **Table**: Left increase right increase, left decrease right decrease, top increase and bottom increase, top decrease and bottom decrease, merge cells, unmerge
|
||||
- [x] **Markdown**: Title, quote, table, image, code block, **Highlight block (similar to vuepress :::)**, various lists, bold, italic, strikethrough...
|
||||
- [x] **AI**: AI continuation, AI optimization, AI proofreading, AI translation, custom AI menu and prompts
|
||||
- [x] **More**: internationalization, light theme, dark theme, mobile phone adaptation, full screen editing, @XXX (mention)...
|
||||
- [x] Modern UI style similar to Tencent Documents
|
||||
|
||||
|
||||
## To be improved (under planning...)
|
||||
## Under development...
|
||||
|
||||
- [ ] Collaboration
|
||||
- [ ] Automated test
|
||||
- [ ] insert AI picture
|
||||
- [ ] AI drawing (AI picture optimization)
|
||||
- [ ] AI typesetting
|
||||
- [ ] Enhance the paste features
|
||||
- [ ] Automatically obtain thumbnails for upload videos
|
||||
- [ ] WORD import, export
|
||||
- [ ] PDF export, preview
|
||||
- [ ] Notion-like operation
|
||||
- [ ] More llm integrated: ChatGPT
|
||||
- [ ] Team collaboration
|
||||
- [ ] AI image insertion (AI text-to-image)
|
||||
- [ ] AI image generation (AI image-to-image)
|
||||
- [ ] AI one-click typesetting
|
||||
- [ ] Further enhance the paste function
|
||||
- [ ] Automatically obtain thumbnails when uploading videos
|
||||
- [ ] WORD import and export
|
||||
- [ ] PDF export, PDF preview
|
||||
- [ ] Notion-like drag and drop features
|
||||
|
||||
## Quick start
|
||||
|
||||
Visit: https://aieditor.dev/getting-started.html
|
||||
|
||||
## Communication
|
||||
|
||||
QQ group: 560291578
|
||||
Visit the official website: https://aieditor.dev/getting-started.html
|
||||
|
|
|
|||
58
readme.zh.md
58
readme.zh.md
|
|
@ -1,24 +1,58 @@
|
|||
<h4 align="right"><a href="./readme.md">English</a> | <strong>简体中文</strong></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
# AiEditor
|
||||
<div style="text-align: center">
|
||||
|
||||
关于 AiEditor（官网 https://aieditor.dev ）
|
||||
<img src="./docs/assets/image/logo.png" style="width: 100px">
|
||||
|
||||
> AiEditor 是一个面向 AI 的下一代富文本编辑器，她基于 Web Component，因此支持 Layui、Vue、React、Angular 等几乎任何前端框架。她适配了 PC Web 端和手机端，并提供了 亮色 和 暗色 两个主题。除此之外，她还提供了灵活的配置，开发者可以方便的使用其开发任何文字编辑的应用。
|
||||
# <a href="https://aieditor.dev" tar>AIEditor.dev</a>
|
||||
|
||||
## AI 驱动的开源富文本编辑器
|
||||
|
||||
开箱即用、支持所有前端框架、支持 Markdown 书写模式
|
||||
|
||||
<img src="./docs/assets/image/index-banner1.png" style="width: 90%">
|
||||
|
||||
</div>
|
||||
|
||||
## 开始关注并使用 AIEditor
|
||||
|
||||
给我们 star，这样，在我们发布新的版本时，您可以及时获得通知。
|
||||
|
||||
<img src="./docs/assets/image/star.gif" style="width: 90%">
|
||||
|
||||
|
||||
## 什么是 AIEditor
|
||||
|
||||
AiEditor 是一个面向 AI 的下一代富文本编辑器，她基于 Web Component，因此支持 Layui、Vue、React、Angular 等几乎任何前端框架。她适配了 PC Web
|
||||
端和手机端，并提供了 亮色 和 暗色 两个主题。除此之外，她还提供了灵活的配置，开发者可以方便的使用其开发任何文字编辑的应用。
|
||||
|
||||
更多关于 AiEditor，请访问官网： https://aieditor.dev
|
||||
|
||||
|
||||
## AIEditor 的与众不同之处
|
||||
|
||||
### 1、AI 驱动的编辑器
|
||||
AIEditor 的目标是打造一个完全由 AI 驱动的富文本编辑器，同时支持对接任意大模型，包括私有的大模型。允许用户使用自己私有的大模型 ApiKey。
|
||||
不仅如此，AIEditor 其所有的 AI 功能，都允许用户自定义自己的 prompt，以及扩展的 AI 菜单。
|
||||
|
||||
|
||||
### 2、简单、友好、易用
|
||||
|
||||
AIEditor 基于 Web Component 开发，支持与任意主流的前端框架集成。AIEditor 使用更加友好的 LGPL 开源协议，通过 `npm i aieditor` 使用，
|
||||
不用担心 GPL 协议可能带来的 GPL 传染问题。
|
||||
|
||||
|
||||
### 3、除了开源版，还提供商业版
|
||||
除了开源版以外，我们还提供了功能更加强大的商业，商业版不限制用户量、不限制应用数量。更多商业版的对比，
|
||||
可以参考这里：https://aieditor.dev/versions.html
|
||||
|
||||
|
||||
## 在线演示
|
||||
|
||||
- 现代风格（类腾讯文档）: http://aieditor1.jpress.cn
|
||||
- 经典/传统风格: http://aieditor.jpress.cn
|
||||
- 基于 AiEditor 二开的商业产品：https://aimp.cc
|
||||
|
||||
|
||||
|
||||
- 经典/传统风格: https://aieditor.dev/demo.html
|
||||
|
||||
|
||||
## 已完善
|
||||
|
|
@ -31,12 +65,12 @@
|
|||
- [x] **Markdown**：标题、引用、表格、图片、代码块、**高亮块（类似 vuepress 的 :::）**、各种列表、粗体、斜体、删除线...
|
||||
- [x] **A I**：AI 续写、AI 优化、AI 校对、AI 翻译、自定义 AI 菜单及其 Prompts
|
||||
- [x] **更多**：国际化、亮色主题、暗色主题、手机适配、全屏编辑、@某某某（提及）...
|
||||
- [x] 类腾讯文档现代 UI 风格
|
||||
|
||||
|
||||
## 待完善（计划中...）
|
||||
## 开发中...
|
||||
|
||||
- [ ] 团队协作
|
||||
- [ ] 自动化测试
|
||||
- [ ] AI 插入图片
|
||||
- [ ] AI 图生图（AI 图片优化）
|
||||
- [ ] AI 一键排版
|
||||
|
|
@ -44,9 +78,7 @@
|
|||
- [ ] 上传视频自动获取缩略图
|
||||
- [ ] WORD 导入、导出
|
||||
- [ ] PDF 导出、PDF 预览
|
||||
- [x] 类腾讯文档 UI 风格
|
||||
- [ ] 类 Notion 拖拽功能
|
||||
- [ ] 更多的大模型对接：文心一言、ChatGPT
|
||||
|
||||
## 快速开始
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue