diff --git a/README.md b/README.md index 750001fd..6234f63d 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ English | [中文说明](./README_ZH-CN.md) ## Highlights - **Easy to use:** Use *Monaco* kernel, optimize for Markdown editing, and have the same editing experience as VSCode. -- **Powerful:** Support version control; Applets, runnable code blocks, tables, PlantUML, Drawio, macro replacements, etc., can be embedded in the document. +- **Powerful:** Support version control; Applets, runnable code blocks, tables, PlantUML, Drawio, macro replacements, etc., can be embedded in the document; support for [OpenAI](https://openai.com) auto completion. - **High compatibility:** Data is saved as local Markdown files, and the extension functions are implemented in the original syntax of Markdown as far as possible. - **Plug-in extension:** Support users to write their own plug-ins to expand the functionality of the editor. - **Encryption supported:** Use encryption to save private files such as account number, and the password can be set separately for each file. @@ -78,6 +78,7 @@ For more information on how to use the following functions, please see [characte - **Custom container:** support custom containers similar to VuePress default themes - **Macro replacement:** support for embedded JavaScript expressions to dynamically replace document content - **Image hosting service:** support [PicGo](https://picgo.github.io/PicGo-Doc/) image hosting service +- **OpenAI: ** support for [OpenAI](https://openai.com) auto completion - **Custom plug-ins:** support writing JavaScript plug-ins to expand editor functionality. The plug-in is placed in the `home directory/plugins`. Refer to [plug-in Development Guide](./help/PLUGIN.md) ## Screenshots diff --git a/README_ZH-CN.md b/README_ZH-CN.md index 94805d7c..eed7f1de 100644 --- a/README_ZH-CN.md +++ b/README_ZH-CN.md @@ -13,7 +13,7 @@ ## 特色 - **使用方便**：使用 Monaco 内核，专为 Markdown 优化，拥有和 VSCode 一样的编辑体验。 -- **功能强大**：支持历史版本回溯；可在文档中嵌入小工具、可运行的代码块、表格、PlantUML 图形、Drawio 图形、宏替换等。 +- **功能强大**：支持历史版本回溯；可在文档中嵌入小工具、可运行的代码块、表格、PlantUML 图形、Drawio 图形、宏替换等；支持接入 [OpenAI](https://openai.com) 自动补全。 - **兼容性强**：数据保存为本地 Markdown 文件；拓展功能尽量用 Markdown 原有的语法实现。 - **插件拓展**：支持用户编写自己的插件来拓展编辑器的功能。 - **支持加密**：用来保存账号等隐私文件，文件可单独设置密码。 @@ -78,6 +78,7 @@ V3 核心目标是重构代码，提升应用健壮性、可拓展性、Markdown - **容器块:** 支持类似 VuePress 默认主题的自定义容器 - **宏替换:** 支持内嵌 JavaScript 表达式动态替换文档内容 - **图床:** 支持 [PicGo](https://picgo.github.io/PicGo-Doc/) 图床 +- **OpenAI: ** 支持接入 [OpenAI](https://openai.com) 自动补全 - **自定义插件:** 支持编写 JavaScript 插件拓展编辑器功能。插件放置在 `主目录/plugins` 中。参考[插件开发指南](./help/PLUGIN_ZH-CN.md) ## 截图 diff --git a/help/FEATURES.md b/help/FEATURES.md index c7c4b611..d209d7e2 100644 --- a/help/FEATURES.md +++ b/help/FEATURES.md @@ -514,6 +514,14 @@ test 3 ::: :::: +## OpenAI Auto Completion + +Yank Note integrates with [OpenAI](https://openai.com), press `[= $ctx.command.getKeysLabel('plugin.editor-openai.trigger') =]` to trigger intelligent completion. + +Note: OpenAI API token needs to be obtained by yourself. + + + ## Front Matter The page supports configuration information similar to [Jekyll Front Matter](https://jekyllrb.com/docs/front-matter/) diff --git a/help/FEATURES_ZH-CN.md b/help/FEATURES_ZH-CN.md index d2e573f3..53b7ec5f 100644 --- a/help/FEATURES_ZH-CN.md +++ b/help/FEATURES_ZH-CN.md @@ -513,6 +513,14 @@ test 3 ::: :::: +## OpenAI 自动补全 + +Yank Note 接入了 [OpenAI](https://openai.com)，按下 `[= $ctx.command.getKeysLabel('plugin.editor-openai.trigger') =]` 即可实现智能补全。 + +注：OpenAI API token 需要你自行获取。 + + + ## Front Matter 页面支持类似 [Jekyll Front Matter](https://jekyllrb.com/docs/front-matter/) 配置信息 diff --git a/help/openai.mp4 b/help/openai.mp4 new file mode 100644 index 00000000..3f646c31 Binary files /dev/null and b/help/openai.mp4 differ