docsify 即时生成文档网站。与 GitBook 不同的是,它不会生成静态 html 文件。相反,它会巧妙地加载和解析 Markdown 文件并将它们显示为网站。 特征
快速开始建议docsify-cli全局安装,有助于在本地初始化和预览网站。 初始化如果要在./docs子目录下编写文档,可以使用init命令。 写作内容完成后,可以在子目录init中看到文件列表。./docs
可以轻松地更新文档中的内容./docs/README.md,当然也可以添加更多页面。 预览网站使用运行本地服务器docsify serve。可以在浏览器上预览网站 手动初始化如果不喜欢npm或无法安装该工具,可以手动创建index.html:
指定 docsify 版本v4.x.x请注意,在以下两个示例中,当发布新的 docsify 主要版本时(例如=> v5.x.x),需要手动更新 docsify URL 。定期检查 docsify 网站以查看是否发布了新的主要版本。 在 URL ( ) 中指定主要版本@4将允许站点自动接收非破坏性增强(即“次要”更新)和错误修复(即“补丁”更新)。这是加载 docsify 资源的推荐方式。
如果希望将 docsify 锁定到特定版本,请@在 URL 中的符号后面指定完整版本。这是确保网站外观和行为方式相同的最安全方法,无论对未来版本的 docsify 进行任何更改。
手动预览网站如果系统上安装了 Python,可以轻松地使用它来运行静态服务器来预览站点。 加载对话框如果愿意,可以在 docsify 开始渲染文档之前显示一个加载对话框:
如果改变了,应该设置data-app属性el:
配置window.$docsify可以通过定义为对象来配置 Docsify :
配置也可以定义为一个函数,在这种情况下,第一个参数是 Docsifyvm实例。该函数应返回一个配置对象。vm这对于在诸如降价配置之类的地方进行引用很有用:
加载导航栏
_navbar.md如果为true则从 Markdown 文件加载导航栏,否则从指定的路径加载它。
加载侧边栏
_sidebar.md如果为true则从 Markdown 文件加载侧边栏,否则从指定的路径加载它。
隐藏侧边栏
此选项将完全隐藏您的侧边栏,并且不会在侧面呈现任何内容。
主页
README.md在 docs 文件夹中将被视为网站的主页,但有时可能需要提供另一个文件作为主页。
如果在侧边栏中有指向主页的链接,并希望在访问根 url 时将其显示为活动状态,请确保相应地更新侧边栏:
主题有一些可用的主题,包括官方和社区制作的。复制Vue和buble网站自定义主题以及@liril-net贡献的黑色风格主题。
压缩文件在
如果有任何想法或想要开发新主题,欢迎提交pull request。 GitHub 页面有三个地方可以为 GitHub 存储库填充文档:
建议将文件保存到存储库分支的./docs子文件夹中。master然后master branch /docs folder在存储库的设置页面中选择作为 GitHub Pages 源。 GitLab 页面如果要部署 master 分支,请.gitlab-ci.yml使用以下脚本创建一个: .public解决方法是cp不会在无限循环中复制到public/自身。
传送门开源协议:MIT license 开源地址:https://github.com/docsifyjs/docsify -END- |
|