让网站运营更简单
让搜索引擎更喜欢的网站
立即咨询
福利,定制网站送小程序, 名额有限,先到先得
《开源精选》是我们分享Github、Gitee等开源社区中优质项目的栏目,包括技术、学习、实用与各种有趣的内容本期推荐的docsify 即时生成您的文档网站与 GitBook 不同的是,它不会生成静态 html 文件。
相反,它会巧妙地加载和解析您的 Markdown 文件并将它们显示为网站
特征没有静态构建的 html 文件简单轻便智能全文搜索插件多个主题有用的插件 API表情符号支持兼容IE11支持服务端渲染快速开始建议docsify-cli全局安装,有助于在本地初始化和预览网站npm i docsify-cli -g在子目录init中
初始化如果要在./docs子目录下编写文档,可以使用init命令docsify init ./docs写作内容完成后,您可以在子目录init中看到文件列表./docsindex.html作为入口文件README.md作为主页
.nojekyll防止 GitHub Pages 忽略以下划线开头的文件您可以轻松地更新文档中的内容./docs/README.md,当然您也可以添加更多页面预览您的网站使用 运行本地服务器docsify serve。
ocalhost:3000docsify serve docs手动初始化如果您不喜欢npm或无法安装该工具,您可以手动创建index.html:
content="width=device-width,initial-scale=1">
/>window.$docsify = { //... }
="//cdn.jsdelivr.net/npm/docsify@4">指定 docsify 版本v4.x.x请注意,在以下两个示例中,当发布新的 docsify 主要版本时(例如=> v5.x.x),需要手动更新 docsify URL 。
定期检查 docsify 网站以查看是否发布了新的主要版本在 URL ( ) 中指定主要版本@4将允许您的站点自动接收非破坏性增强(即“次要”更新)和错误修复(即“补丁”更新)这是加载 docsify 资源的推荐方式。
>如果您希望将 docsify 锁定到特定版本,请@在 URL 中的符号后面指定完整版本这是确保您的网站外观和行为方式相同的最安全方法,无论对未来版本的 docsify 进行任何更改<
linkrel="stylesheet"href="//cdn.jsdelivr.net/npm/docsify@4.11.4/themes/vue.css">
>手动预览您的网站如果您的系统上安装了 Python,您可以轻松地使用它来运行静态服务器来预览您的站点cd docs && python -m SimpleHTTPServer 3000。
cd do
divid="app">Please wait...如果你改变了,你应该设置data-app属性el:Please wait...
window.$docsify = { el: #main } 配置window.$docsify您可以通过定义为对象来配置 Docsify :
window.$docsify = { repo: docsifyjs/docsify, maxLevel: 3, coverpage: true, };
扫一扫,关注我们