首页 > 其他分享 >个人docsify在线文档搭建

个人docsify在线文档搭建

时间:2023-02-07 21:12:33浏览次数:59  
标签:md part1 part2 文档 README docsify true 搭建

一、创建docsify项目

官网:https://docsify.js.org/#/

1、前期准备

npm i docsify-cli -g

2、创建项目

  创建一个项目文件夹,并进入文件夹:

docsify init ./docs

二、docsify项目配置

1、侧边栏

  • _sidebar.md

其作用类似于gitbook中的SUMMARY.md

- [首页](README)
- [第一章](part1/README.md)
  - [1.1 第一节](part1/writing.md)
  - [1.2 第二节](part1/gitbook.md)
- [第二章](part2/README.md)
  - [2.1 第一节](part2/feedback_please.md)
  - [2.2 第二节](part2/better_tools.md)
  • index.html
      window.$docsify = {
        loadSidebar: true,
        subMaxLevel: 2,
      };

2、封面

  • _coverpage.md
<!-- _coverpage.md -->

![logo](_media/icon.svg)

# docsify

> 一个神奇的文档网站生成器。

[GitHub](https://github.com/docsifyjs/docsify/)
[Get Started](README.md)

<!-- 背景图片 -->
![](_media/bg.png)

<!-- 背景色 -->
![color](#f0f0f0)
  • index.html
      window.$docsify = {
        coverpage: true,
        onlyCover: true,
      };

三、部署

1、方式1

  在对应的 Gitee 仓库服务中选择 Gitee Pages,选择您要部署的分支,填写您要部署的分支上的目录,例如docs,填写完成之后点击启动即可。

2、方式2

  使用vercel 自动部署。

标签:md,part1,part2,文档,README,docsify,true,搭建
From: https://www.cnblogs.com/Lencamo/p/17099761.html

相关文章

  • javaWeb01-使用idea快速搭建web项目
    本文主要讲述如何使用idea【这里的idea是2021年的】快速搭建web项目【没有使用maven创库】第一步:new->project第二步:选择java空项目第三步:选择路径以及......
  • TagUI机器人流程自动化搭建与简单脚本#这是我在51CTO博客的第一篇博文
    这是我在51CTO博客的第一篇博文。下载TagUI安装包,安装即可:​​TagUIv6.46Windows安装包​​安装好之后,测试一下。新建一个文本文档,在里面输入百度的网址​​https://www.......
  • ONLYOFFICE文档​ TEXTBEFORE, TEXTAFTER, TEXTSPLIT 公式
    ​公式编辑器与常见的文字处理软件和演示程序配合使用,特别是数学编辑器已经成为当下互联网最常用的软件之一,在各种文档中加入复杂的数学公式和符号,在编辑试卷、书籍等途径上......
  • LeaRun快速开发平台:自由搭建个性化门户
    门户是一个应用软件呈现给用户的第一印象,它作为应用框架,将各种应用系统、数据资源和互联网资源集成整合到一个信息管理平台上,再用统一界面呈现给用户,使企业可以快速建立企......
  • LeaRun快速开发平台:自由搭建个性化门户
    门户是一个应用软件呈现给用户的第一印象,它作为应用框架,将各种应用系统、数据资源和互联网资源集成整合到一个信息管理平台上,再用统一界面呈现给用户,使企业可以快速建立企业......
  • Django+Pytest+Jenkins搭建持续集成自动化测试
    系统环境采用的是Mac系统环境下搭建自动化框架。设计思路持续集成测试:定时某时间自动执行测试脚本,接口测试可用Jmeter+ant+allure+Jenkins进行搭建接口持续集成测试,这个针对......
  • 产品方案相关文档结构
    协同办公系统研发方案一、项目概述本项目旨在开发一套高效的协同办公系统,以满足企业的管理和协同办公需求。该系统将提供一个集成的管理平台,支持企业内部的协同办公、......
  • 手把手教你用LOTO虚拟示波器搭建测试系统整机
          虚拟示波器如果用于个人的研发调试工作,主要能体现出它的小巧便携以及功能强大。而它的另一个巨大优势,可集成性可定制性高,则是在我们做项目中搭建测试系统的时......
  • 使用Kubernetes搭建带有ik分词的Elasticsearch集群
    创建好带有Ik分词的es镜像,并上传到镜像仓库中,创建镜像可参考链接中的文档https://www.cnblogs.com/hi-lijq/p/16895206.html编写es_cluster-ik-config.yaml文件apiVe......
  • 陪诊小程序开发|陪护系统功能搭建
     近两年来,陪诊这个词开始逐渐出现在我们的生活当中,毕竟现在年轻人大多工作都比较忙,父母去医院又不太懂那些信息化的操作,这个时候能有一个人陪伴在父母身边,帮助父母解决在......