quick-docsify

1.0.3 • Public • Published

quick-docsify

基于 docsify 的快速文档系统构建框架

第一步:安装 docsify

# 安装docsify-cli 
npm install docsify-cli -g
 
# 启动本地服务 
docsify serve

第二步:删除不必要文件

  1. 首先认识一下当前框架的目录结构
|-- article 示例文件,[可删除]
|-- _coverpage.md 封面内容
|-- _navbar.md 顶部导航导航栏配置内容
|-- _sidebar.md 左侧侧边导航栏配置内容
|-- .nojekyll 防止github page 忽略下划线文件
|-- 快速上手.md 示例文档 [可删除]
|-- index.html 入口文件
|-- README.md 示例文档 [可删除]
  1. 酌情删除或修改

第三步:配置相关内容

包括以下几个文件:_coverpage.md_sidebar.md_navbar.md

更多配置请查看index.html文件,所有的配置几乎都集中在 index.html 文件中。

更多关于 docsify 请参考以下链接:

示例(Example)

quick-docsify示例

Package Sidebar

Install

npm i quick-docsify

Weekly Downloads

1

Version

1.0.3

License

ISC

Unpacked Size

2.58 MB

Total Files

13

Last publish

Collaborators

  • jingping.ye