Obsidian笔记发布项目技术文档

Obsidian笔记发布项目技术文档

obsidian-publish-mkdocs A Template to Publish Obsidian/Foam Notes on Github Pages (uses MkDocs) 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-publish-mkdocs

安装指南

1. 创建GitHub仓库

• 使用本模板创建一个新的GitHub仓库。点击页面顶部的绿色按钮或使用此链接。
• 为你的仓库命名。默认情况下，你的笔记将发布在https://username.github.io/repo-name/。
• 创建仓库时，仅复制main分支。

2. 克隆仓库

• 将生成的仓库克隆到你的Obsidian文件夹/库中。

3. 移动笔记

• 将你希望公开的笔记移动到repo-name/docs文件夹中。最简单的方法是使用Obsidian中的拖放功能。

4. 提交并推送更改

• 提交并推送更改。GitHub Actions将自动处理其余部分，使用MkDocs和Material主题发布你的笔记。

5. 配置GitHub Pages

• 转到Settings > Pages，选择gh-pages分支作为源。

项目的使用说明

1. 笔记组织

• 默认情况下，页面和部分将遵循/docs文件夹中的文件夹结构。文件夹和子文件夹将显示为部分。
• 避免在文件夹和文件名中使用空格，因为这些将被转换为HTML链接。网页标题将与Markdown笔记中的第一级标题相同。

2. 自定义导航

• 如果你想手动安排页面，可以使用mkdocs.yml配置文件中的nav选项设置自定义页面导航。
• Material主题提供了多种选项来安排部分、使用导航标签等。

项目API使用文档

1. MkDocs配置

• 使用mkdocs.yml文件配置MkDocs。你可以设置自定义导航、主题选项等。

2. Material主题配置

• Material主题提供了丰富的配置选项，包括导航设置、主题颜色、字体等。详细配置请参考Material主题文档。

项目安装方式

1. 使用GitHub模板

• 通过GitHub模板创建一个新的仓库。

2. 克隆到本地

• 将仓库克隆到本地Obsidian文件夹/库中。

3. 移动笔记

• 将笔记移动到docs文件夹中。

4. 提交并推送

• 提交更改并推送到GitHub。

5. 配置GitHub Pages

• 在GitHub Pages设置中选择gh-pages分支作为源。

obsidian-publish-mkdocs A Template to Publish Obsidian/Foam Notes on Github Pages (uses MkDocs) 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-publish-mkdocs