Skip to content

Commit

Permalink
add README-en.md
Browse files Browse the repository at this point in the history
  • Loading branch information
obgnail committed Mar 2, 2025
1 parent 8904472 commit 3b5ca7f
Show file tree
Hide file tree
Showing 13 changed files with 765 additions and 22 deletions.
742 changes: 742 additions & 0 deletions README-en.md

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
</p>
</div>

简体中文 | [English](https://github.com/obgnail/markdown-finder/blob/master/README-en.md)

| # | 插件 | 功能 | 默认启用 |
| ---- | ----------------------- | -------------------------------------- | -------- |
Expand Down Expand Up @@ -151,7 +152,7 @@ yay -S typora-plugin

项目包含 600+ 配置选项,可以比较完整定义各个插件的行为。

所有配置位于 [settings](https://github.com/obgnail/typora_plugin/tree/master/plugin/global/settings) 目录中。修改配置方法请阅读该目录下的 [说明文件](https://github.com/obgnail/typora_plugin/blob/master/plugin/global/settings/%E8%AF%B7%E8%AF%BB%E6%88%91.md)
所有配置位于 [settings](https://github.com/obgnail/typora_plugin/tree/master/plugin/global/settings) 目录中。修改配置方法请阅读该目录下的 [说明文件](https://github.com/obgnail/typora_plugin/blob/master/plugin/global/settings/README.md)



Expand Down Expand Up @@ -810,15 +811,15 @@ Typora 自带 ripgrep。此插件支持使用内建的 ripgrep 进行文件搜
功能:提供开放能力,支持用户自己写插件。

具体使用请参考 [请读我.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/custom/%E8%AF%B7%E8%AF%BB%E6%88%91.md)
具体使用请参考 [README.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/custom/README.md)



### json_rpc:外部操纵 Typora(高级)

功能:将包括 typora-plugin 所有功能在内的一切能力通过 `json-rpc` 的形式暴露出去,以供外部操纵 Typora。

具体使用请参考 [请读我.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/json_rpc/%E8%AF%B7%E8%AF%BB%E6%88%91.md)
具体使用请参考 [README.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/json_rpc/README.md)

> 此插件是高级插件,仅对开发人员开放。开启此插件后,外部将拥有 node、browser 两套环境,能完全控制电脑,因此如果您不是开发人员,请勿开启此插件。
>
Expand All @@ -829,7 +830,7 @@ Typora 自带 ripgrep。此插件支持使用内建的 ripgrep 进行文件搜

功能:用户点击或者使用快捷键触发当前文章的自动发布功能,程序根据用户配置自动发布博客文章到各大平台

具体使用参考: [请读我.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/article_uploader/%E8%AF%B7%E8%AF%BB%E6%88%91.md)。以上传到 CSDN 为例,Gif 图如下:
具体使用参考: [README.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/article_uploader/README.md)。以上传到 CSDN 为例,Gif 图如下:

![CSDN 成功演示](https://my-picture-bed1-1321100201.cos.ap-beijing.myqcloud.com/mypictures/CSDN%E6%88%90%E5%8A%9F%E6%BC%94%E7%A4%BA.gif)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@

下载完成以后,有两处可供配置。

1. 配置插件`显示隐藏``插件名称``快捷键`等信息,与插件配置相同,参考:[typora_plugin/plugin/global/settings/请读我.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/global/settings/请读我.md)
1. 配置插件`显示隐藏``插件名称``快捷键`等信息,与插件配置相同,参考:[typora_plugin/plugin/global/settings/README.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/global/settings/README.md)

<img src="https://my-picture-bed1-1321100201.cos.ap-beijing.myqcloud.com/mypictures/image-20240527175754400.png" alt="image-20240527175754400" width=50%/>

Expand All @@ -92,7 +92,7 @@

#### 启用

如果您想要**启用**,首先进入`.\plugin\global\settings`,找到`settings.user.toml`文件(初次使用需要先拷贝`settings.default.toml`一份,具体参考作者文档[typora_plugin/plugin/global/settings/请读我.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/global/settings/请读我.md)
如果您想要**启用**,首先进入`.\plugin\global\settings`,找到`settings.user.toml`文件(初次使用需要先拷贝`settings.default.toml`一份,具体参考作者文档[typora_plugin/plugin/global/settings/README.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/global/settings/README.md)

启用`article_uploader`插件并在右键菜单配置中添加下面这个配置

Expand Down
2 changes: 1 addition & 1 deletion plugin/custom/请读我.md → plugin/custom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ module.exports = { plugin: myFullPathCopy }
// 3. hint: 当鼠标移动到右键菜单时的提示
// 4. init: 在这里初始化你要的变量
// 5. style: 给 Typora 插入 style 标签。返回值为 string。若你想指定标签的 id,也可以返回 {textID: "", text: ""}。其中 textID 为此 style 标签的 id,text 为 style 内容
// 6. styleTemplate: 引入 `./plugin/global/user_styles` 目录下和插件同名的 css 文件。详情请参考`./plugin/global/user_styles/请读我.md`
// 6. styleTemplate: 引入 `./plugin/global/user_styles` 目录下和插件同名的 css 文件。详情请参考`./plugin/global/user_styles/README.md`
// 7. html: 为 Typora 插入 HTML 标签,返回 Element 类型或者 Element-string
// 8. hotkey: 为 callback 注册快捷键,返回 Array<string> 类型 或者 [{hotkey: "", callback: () => console.log(123)}]
// 9. beforeProcess: 最先执行的函数,在这里初始化插件需要的数据。若返回 utils.stopLoadPluginError,则停止加载插件
Expand Down
8 changes: 4 additions & 4 deletions plugin/global/locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"__OFTEN_USED_PLUGINS__": "Often Used Plugins"
},
"window_tab": {
"pluginName": "Window Tab",
"pluginName": "Window Tab Bar",
"act.sort_tabs": "Sort Tabs",
"act.save_tabs": "Save Current Tabs",
"act.open_save_tabs": "Open Saved Tabs",
Expand Down Expand Up @@ -406,7 +406,7 @@
"act.toggle_download": "Auto Download online images"
},
"text_stylize": {
"pluginName": "Text Stylize",
"pluginName": "Text Stylization",
"tool.blank": "",
"tool.weight": "Bold",
"tool.italic": "Italic",
Expand Down Expand Up @@ -538,7 +538,7 @@
"act.uninstall_plugin": "Uninstall Plugin",
"act.open_setting_folder": "Edit Configuration",
"act.backup_setting_file": "Backup Configuration",
"act.show_setting": "Plugin Configuration",
"act.show_setting": "Show Configuration",
"act.show_env": "Environment Information",
"act.set_user_styles": "Edit Styles",
"act.new_custom_plugin": "Develop a Plugin",
Expand Down Expand Up @@ -636,7 +636,7 @@
"pluginName": "Callouts"
},
"templater": {
"pluginName": "Templater",
"pluginName": "File Templater",
"filename": "Filename",
"template": "Template",
"preview": "Preview",
Expand Down
2 changes: 1 addition & 1 deletion plugin/global/locales/zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@
"act.uninstall_plugin": "卸载插件",
"act.open_setting_folder": "修改配置",
"act.backup_setting_file": "备份配置",
"act.show_setting": "插件配置",
"act.show_setting": "查看配置",
"act.show_env": "环境信息",
"act.set_user_styles": "修改样式",
"act.new_custom_plugin": "我要写插件",
Expand Down
2 changes: 1 addition & 1 deletion plugin/global/locales/zh-TW.json
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@
"act.uninstall_plugin": "解除安裝插件",
"act.open_setting_folder": "修改設定",
"act.backup_setting_file": "備份設定",
"act.show_setting": "插件設定",
"act.show_setting": "查看設定",
"act.show_env": "環境資訊",
"act.set_user_styles": "修改樣式",
"act.new_custom_plugin": "我要寫插件",
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions plugin/global/settings/custom_plugin.default.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#-------------------------------------------------------------------------
# 请勿修改【custom_plugin.default.toml】文件,请阅读本目录下的【请读我.md】
# 请勿修改【custom_plugin.default.toml】文件,请阅读本目录下的【请读我.md】
# 请勿修改【custom_plugin.default.toml】文件,请阅读本目录下的【请读我.md】
# 请勿修改【custom_plugin.default.toml】文件,请阅读本目录下的【README.md】
# 请勿修改【custom_plugin.default.toml】文件,请阅读本目录下的【README.md】
# 请勿修改【custom_plugin.default.toml】文件,请阅读本目录下的【README.md】
#-------------------------------------------------------------------------


Expand Down
6 changes: 3 additions & 3 deletions plugin/global/settings/settings.default.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#-------------------------------------------------------------------------
# 请勿修改【settings.default.toml】文件,请阅读本目录下的【请读我.md】
# 请勿修改【settings.default.toml】文件,请阅读本目录下的【请读我.md】
# 请勿修改【settings.default.toml】文件,请阅读本目录下的【请读我.md】
# 请勿修改【settings.default.toml】文件,请阅读本目录下的【README.md】
# 请勿修改【settings.default.toml】文件,请阅读本目录下的【README.md】
# 请勿修改【settings.default.toml】文件,请阅读本目录下的【README.md】
#-------------------------------------------------------------------------


Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions plugin/help.js
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,9 @@ class helpPlugin extends BasePlugin {
const map = {
open_setting_folder: () => this.utils.runtime.openSettingFolder(),
backup_setting_file: () => this.utils.runtime.backupSettingFile(),
set_user_styles: () => this.utils.showInFinder(this.utils.joinPath("./plugin/global/user_styles/请读我.md")),
new_custom_plugin: () => this.utils.showInFinder(this.utils.joinPath("./plugin/custom/请读我.md")),
json_rpc: () => this.utils.showInFinder(this.utils.joinPath("./plugin/json_rpc/请读我.md")),
set_user_styles: () => this.utils.showInFinder(this.utils.joinPath("./plugin/global/user_styles/README.md")),
new_custom_plugin: () => this.utils.showInFinder(this.utils.joinPath("./plugin/custom/README.md")),
json_rpc: () => this.utils.showInFinder(this.utils.joinPath("./plugin/json_rpc/README.md")),
github_picture_bed: () => this.utils.openUrl("https://github.com/obgnail/typora_image_uploader"),
update_plugin: () => this.updater && this.updater.call(),
preferences: () => this.preferences && this.preferences.call(),
Expand Down
File renamed without changes.

0 comments on commit 3b5ca7f

Please sign in to comment.