Skip to content

Latest commit

 

History

History
214 lines (123 loc) · 6.43 KB

请读我.md

File metadata and controls

214 lines (123 loc) · 6.43 KB
Raw

请根据你的勤奋程度选择 懒人版本 或 详细版本。

懒人版本

修改配置前，你只需了解两点：

  • 你只能修改后缀为 user.toml 的文件，后缀为 default.toml 的文件不要修改
  • settings.user.toml 用于配置一级插件， custom_plugin.user.toml 用于配置二级插件（常用插件->二级插件 下的插件）

如何修改配置？

  1. 将 settings.default.toml 里的内容粘贴（覆盖）到 settings.user.toml 里。保证两个文件的内容是一样的。
  2. 同理，将 custom_plugin.default.toml 里的内容粘贴（覆盖）到 custom_plugin.user.toml 里。保证两个文件的内容是一样的。
  3. 关闭两个 default.toml 文件。
  4. 若你要修改的是 常用插件->二级插件 下的插件，请打开 custom_plugin.user.toml 文件；否则请打开 settings.user.toml 文件。
  5. 使用 ctrl+F 查找你要修改的插件的中文名（在右键菜单中的名字），根据里面的说明文字修改。
  6. 保存，重启 Typora。

修改后，如果发现 Typora 出现问题，不知道怎么恢复，直接清空 settings.user.toml 和 custom_plugin.user.toml 文件内容，再重启即可。

详细版本

XXX.default.toml 和 XXX.user.toml 的区别是什么？

  • XXX.default.toml：默认的配置，请不要修改。
  • XXX.user.toml：用户的配置，优先级高于 XXX.default.toml。

简单来说，插件系统会优先从 user.toml 获取配置项；若 user.toml 没有对应的配置项，则从 default.toml 获取。

为何如此设计：区分 用户配置 和 默认配置。升级插件过程中，default.toml 被不断修改，而 user.toml 会被尊重和保留。这样就实现了随着插件的升级，功能不断丰富并且保留用户个性化设置。

settings.XXX.toml 和 custom_plugin.XXX.toml 的区别是什么？

  • custom_plugin.XXX.toml：用户自定义插件的配置。从右键菜单上看，所有 常用插件->二级插件 下的插件的配置都在这里。
  • settings.XXX.toml： 默认插件的配置。从右键菜单上看，其余所有插件的配置都在这里。

简单来说，一级插件从 settings.XXX.toml 获取配置项，二级插件（常用插件->二级插件 下的插件）从 custom_plugin.XXX.toml 获取配置项。

为何如此设计：区分 用户插件 和 默认插件。本插件系统提供了开放能力，用户可以自定义插件，其中自定义插件的配置就要写在 custom_plugin.user.toml。

hotkey.XXX.toml 的功能是什么？

hotkey.XXX.toml：为【任何插件功能】或【任何自定义函数】绑定自定义快捷键，仅当 hotkeyHub 插件启用时生效。

此配置是高级配置，仅对有 javascript 基础的用户开放。

如何修改插件的配置？

简单方法

见懒人版本。

复杂方法（推荐）

以 修改只读模式的 HOTKEY 和 READ_ONLY_DEFAULT 配置 为例。

  1. 首先打开 settings.default.toml，找到你想修改的插件（read_only），发现配置如下：

    [read_only]
# 启用插件
ENABLE = true
# 在右键菜单中展示的名称
NAME = "只读模式"
# 是否在右键菜单中可点击
CLICKABLE = true
# 进入和脱离只读模式的快捷键
HOTKEY = "ctrl+shift+r"
# 默认使用只读模式
READ_ONLY_DEFAULT = false
# 开启只读模式后，右下角数字统计区域出现的提示文字
SHOW_TEXT = "ReadOnly"

  2. 打开 settings.user.toml，添加如下内容：

    [read_only]
READ_ONLY_DEFAULT = true     # 打开Typora时会自动进入只读模式
HOTKEY = "ctrl+alt+shift+r"  # 快捷键修改为ctrl+alt+shift+r

  3. 这样一来，settings.user.toml 里的 HOTKEY 和 READ_ONLY_DEFAULT 选项就会覆盖掉 settings.default.toml，并且 其他选项保持不变。

  4. 保存，重启 Typora。

为什么推荐此种方法？因为复杂方法是 部分修改，而简单方法是 全量修改。好处在于：精准。复杂方法只修改了我感兴趣的部分，其他保持不变；而简单方法的逻辑是：我对所有配置都感兴趣，全部重新修改了一遍。

插件系统会不断迭代，有时候开发者可能会修改某些配置的默认值（也就是 default.toml 的值发生了改变），如果你使用了全量修改，因为 user.toml 的优先级高于 default.toml，因此插件系统只会从 user.toml 获取配置，导致只能拿到旧值，所以插件系统只会使用旧值，直到你手动修改。而部分修改，会因为在 user.toml 中找不到，转去 default.toml 中获取，自然能拿到最新值。

示例

以下是我个人的配置文件，你可以参考一下

settings.user.toml：

[auto_number]
ENABLE_TABLE = false
ENABLE_IMAGE = false
ENABLE_FENCE = false

[fence_enhance]
REMOVE_BUTTON_HINT = true
#INDENTED_WRAPPED_LINE = true
ENABLE_DANGEROUS_FEATURES = true

[custom]
ALLOW_SET_CONFIG_IN_SETTINGS_TOML = false

[right_click_menu]
HIDE_OTHER_OPTIONS = true

[window_tab]
HEIGHT_SCALE = -1

custom_plugin.user.toml：

[openInTotalCommander]
enable = true

[pluginUpdater]
[pluginUpdater.config]
auto_update = false

[autoTrailingWhiteSpace]
enable = false

[reopenClosedFiles]
hide = true
[reopenClosedFiles.config]
auto_reopen_when_init = true

[hotkeyHub]
hide = true

[markdownLint]
hide = true

[imageReviewer]
hide = true

[scrollBookmarker]
hide = true

[darkMode]
hide = true


#[redirectLocalRootUrl]
#enable = false
#[redirectLocalRootUrl.config]
#root = "D:\\tmp\\img"
#filter_regexp = ""

[toc]
enable = true

toml 教程

  • 如果您对 toml 格式不太了解，可以花三分钟时间学习一下：TOML 教程
  • 如果您写入的内容有问题，会导致配置文件无法正确读取，此时请前往 TOML格式校验网站

小提示

如果你没有 vscode、sublime text、notepad2 等能高亮 toml 语法的编辑器，可以复制到 Typora 编辑，之后再粘贴回去，就像上面的示例一样。

小秘密

如果有需要的话，你还可以创建目录 homeDir/.config/typora_plugin/ ，并在里面存放配置文件，而且这里的配置文件 优先级最高。

dir /b C:\Users\用户名\.config\typora_plugin

custom_plugin.user.toml
hotkey.user.toml
settings.user.toml

此方法适用于 Linux、Windows 平台。