Rino Docs:简单的Markdown网站生成🚀
我很懒!有点... 😴 #
你是否发现自己花太多时间添加新页面到你的文档网站上?如果是的话,你并不孤单!维护文档可能是一项繁琐的任务,涉及到文件的复制粘贴和编写Markdown内容。因此,我创建了一个简单的Markdown文档工具,Rino Docs。
Rino Docs是什么? 🤪 #
Rino Docs是一个由Rino.js驱动的简单的Markdown文档工具。它简化了添加新文档页面的过程,并允许你自定义文档网站的设计。
Rino Docs从./src/mds
目录读取Markdown文件,并在./dist
目录生成HTML页面。它的独特之处在于,它能自动生成一个侧边栏组件,其中包含所有文档页面的链接列表。不再需要手动链接。 安装:
npm create rinodocs@latest
开发和构建:
npm run dev
站点地图生成:
npm run sitemap
组织侧边栏链接 🧐
你可能会想知道侧边栏中的链接是如何排序的。很简单!只需在你的 markdown 文件名的开头添加一个数字。Rino Docs 将根据文件名的数字顺序自动排序链接。例如,将文件命名为 '1. Home' 将把它放在侧边栏顶部。
自定义您的文档网站 ✍️
想要自定义文档网站的模板吗?您有灵活性来这样做。只需编辑位于 './src/pages/' 和 './src/components/' 中的文件。如果您需要支持多种语言或进行其他任何调整,请随意编辑项目中的任何文件。
最后一步 🚀
不要让文档耗尽您的时间和精力。试试 Rino Docs,简化您的文档工作流程吧!
有用的链接 🌐