Obsidian 标题编号插件使用教程

Obsidian 标题编号插件使用教程

项目地址:https://gitcode.com/gh_mirrors/nu/number-headings-obsidian

1. 项目的目录结构及介绍

number-headings-obsidian/
├── .github/
├── .obsidian/
├── src/
│   ├── main.ts
│   ├── settings.ts
│   ├── styles.css
│   └── utils.ts
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

• .github/: 包含GitHub相关配置文件。
• .obsidian/: 包含Obsidian插件的配置文件。
• src/: 包含插件的主要源代码文件。
  • main.ts: 插件的主入口文件。
  • settings.ts: 插件的配置设置文件。
  • styles.css: 插件的样式文件。
  • utils.ts: 插件的工具函数文件。
• .gitignore: Git忽略文件配置。
• LICENSE: 插件的许可证文件。
• README.md: 插件的说明文档。
• package.json: 插件的依赖和脚本配置文件。
• tsconfig.json: TypeScript配置文件。

2. 项目的启动文件介绍

插件的主入口文件是 src/main.ts。这个文件负责初始化插件并注册所有必要的命令和事件监听器。以下是 main.ts 的主要功能：

• 初始化插件设置。
• 注册命令，如“Number all headings in document”和“Remove numbering from all headings in document”。
• 监听文档变化，自动更新标题编号。

3. 项目的配置文件介绍

插件的配置文件是 src/settings.ts。这个文件定义了插件的所有可配置选项，并提供了用户界面来修改这些设置。以下是 settings.ts 的主要功能：

• 定义插件的默认设置。
• 提供用户界面来修改设置。
• 保存和加载用户设置。

通过这些配置文件，用户可以自定义标题编号的格式、分隔符等选项，以满足不同的需求。

---

以上是 Obsidian 标题编号插件的基本使用教程，希望对你有所帮助。如果有任何问题，请参考项目的 GitHub 页面 获取更多信息。

number-headings-obsidian Automatically number headings in a document in Obsidian 项目地址: https://gitcode.com/gh_mirrors/nu/number-headings-obsidian