前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >基于 docsify 搭建一个文档

基于 docsify 搭建一个文档

作者头像
子舒
发布2022-06-09 14:24:01
3230
发布2022-06-09 14:24:01
举报
文章被收录于专栏:子舒的个人博客

一、搭建

docsify 是一个类似 vuepress, gitbook 等静态文档程序,但是对比之前,个人还是喜欢 docsify 的风格和源码。不想要那么多附带的功能,能满足写文章,目录的功能就行了。

点击查看demo.

打开终端输入指令,把本地环境搭建起来:

代码语言:javascript
复制
npm install docsify-cli -g

初始化文档:

代码语言:javascript
复制
docsify init ./docs

本地运行:

代码语言:javascript
复制
docs serve

然后在浏览器打开 localhost:3000 就可以查看了。

二、页面

我觉得最基本的页面就三个

  1. _navbar.md

导航栏

代码语言:javascript
复制
* [关于](/)

然后在 index.html 调用。

代码语言:javascript
复制
window.$docsify = {
    ...
    loadNavbar: true,
    ...
}

如图:

  1. _sidebar.md

侧边栏

代码语言:javascript
复制
* [基于docsify搭建一个文档](基于docsify搭建一个文档.md)

在 index.html 调用。

代码语言:javascript
复制
window.$docsify = {
    ...
    loadSidebar: true,
    ...
}

如图:

  1. README.md

主页

代码语言:javascript
复制
## about

博客地址:[https://imhan.cn](https://imhan.cn)

作者:shuxhan

时间:2021.04.20

本文档作为博客的文章备份,如果对文章有一些其他的评论可以直接点击链接到原地址。

如图:

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2021 年 04 月,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 一、搭建
  • 二、页面
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档