appstore-1panel/apps/mkdocs-material/README.md
2023-11-06 22:07:19 +08:00

1.1 KiB
Raw Blame History

使用帮助

进入 /opt/1panel/apps/mkdocs-material/mkdocs-material/data/docs 目录,开始您的撰写。

Material for MkDocs

MkDocs 是一个快速、简单且华丽的静态站点生成器,适用于构建项目文档。文档源文件是用 Markdown 编写的,并使用单个 YAML 配置文件进行配置。

特征:

  • 很棒的主题可供选择MkDocs有一堆好看的主题可供使用。在内置主题之间进行选择 mkdocs和 readthedocs选择第三方主题之一在MkDocs 主题wiki 页面以及MkDocs Catalog上或者构建您自己的.
  • 易于定制:通过自定义主题和/或安装一些插件 ,让您的项目文档看起来就像您想要的那样 。使用Markdown 扩展修改 Markdown 的行为。有许多配置选项可用。
  • 在工作时预览您的网站:内置的开发服务器允许您在编写文档时预览文档。每当您保存更改时,它甚至会自动重新加载并刷新您的浏览器。
  • 随处托管MkDocs 构建完全静态的 HTML 站点,您可以将其托管在 GitHub Pages、Amazon S3 或您选择的任何其他地方。