docsify搭建知识库

2024-04-15 11:34:18

快速开始

推荐全局安装 docsify-cli 工具，可以方便地创建及在本地预览生成的文档。

npm i docsify-cli -g

github新建项目

使用github新建一个项目，并且clone到本地，进入项目根目录，直接通过 init 初始化项目。

docsify init ./docs

本地预览

docsify serve docs

执行完命令打开，在浏览器打开 http://localhost:3000/#/ 就可以看到一个非常简单的页面

美化项目

接下来就是美化我们的项目，封面，侧边栏，主题色。打开docs目录下的index.html找到window.$docsify接下来很多进行配置，接下来很多都是在这里面配置的

设置名字和仓库地址

设置文档名称和仓库地址

<!-- index.html -->
<script>window.$docsify = {  name: 'Tjys Notes', repo: 'https://github.com/qikaile/tjys-notes'}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>

设置封面

首先配置 coverpage，默认加载的文件为 _coverpage.md。具体配置规则见

配置项#coverpage

  window.$docsify = {  coverpage:true   }

新建一个_coverpage.md文件，写一些基础的配置，具体的配置说明就直接官网查看吧cover

新建_media文件夹新建custom.css自定义样式，并且在index.html里引入，并引入了一个新字体。

 <link rel="stylesheet" href="./_media/custom.css"><link href="https://fonts.googleapis.com/css?family=Lobster"rel="stylesheet">

修改下主题色

 window.$docsify = {    themeColor: '#25798A' }

配置侧边栏

显示侧边栏，新建_sidebar.md，配置 loadSidebar 选项，具体配置规则见配置项#loadSidebar。

  window.$docsify = {loadSidebar:true}

写内容

接下来就是写内容了。每一篇文章都是一个md文件，直接编辑 docs/README.md 就能更新文档内容，然后我们将侧边栏的链接指向该文件即可。为了管理方便新建的其他md文件我放到了blog文件夹下面。

到此博客的基本内容就结束了。接下来就是如何让别人看到我们的博客。

部署

把本地的代码提交到github上。然后我们设置一下，在我们的项目下点击setting 找到GitHub Pages设置。

总结

docsify还有很多功能需有待我们探索。

docsify搭建知识库相关推荐

本地 MarkDown 怎么部署到服务器上？教你使用 Docsify 搭建个人博客
使用Docsify搭建文档类型网站 docsify 可以快速帮你生成文档网站.不同于 GitBook.Hexo 的地方是,它不会生成静态的 .html 文件,所有转换工作都是在运行时.如果你想要开始使 ...
docsify安装,docsify搭建,docsify使用教程
docsify安装,docsify搭建,docsify使用教程首先安装docsify-cli脚手架,用于初始化docsify文档项目 npm i docsify-cli -g 然后初始化 docsi ...
docsify搭建个人博客
预览 fearless's blog fearless's puzzle game fearless's github 使用工具一个神奇的文档网站生成器 docsify 安装doocsify npm ...
Prompt learning 教学[进阶篇]：简介Prompt框架并给出自然语言处理技术：Few-Shot Prompting、Self-Consistency等；项目实战搭建知识库内容机器人
Prompt learning 教学[进阶篇]:简介Prompt框架并给出自然语言处理技术:Few-Shot Prompting.Self-Consistency等:项目实战搭建知识库内容机器人 1. ...
在线搭建知识库、帮助中心，优选这5款软件工具！
现在市面上搭建产品手册.知识库.帮助中心的工具多不胜数,但由于产品的功能特性不一样,也就决定了知识库工具所面向的目标受众不一样.这里整理了国内最好用的5款知识库工具. 1.ProProfs 知识库 P ...
使用Docsify搭建Markdown文件服务器
使用docsify快速生成文档网站 1. 概述 2. 安装 docsify-cli 工具 3. 初始化项目 4. 本地预览 5. 多页文档 6. 定制导航栏 6.1 在index.html中添加导航栏 ...
使用HTML搭建知识库,TiddlyWiki 快速入门教程，尝试搭建个人知识库
TiddlyWiki 简介 TiddlyWiki 是一款独特的非线性笔记本,用于捕获.组织和分享复杂信息.可用它来建立个人知识库,或者任务管理.记录闪过你大脑的每一个想法,或者建立一个灵动的自适应式的 ...
使用docsify搭建在线文档中心
准备工作 1.电脑已安装好node 和npm 环境. 2.编辑Markdown文件推荐下载Typora. 点击Typora官网下载吧~ 3.对Markdown语法有一定的了解. 点击Markdown语 ...
如何搭建知识库网页？
随着经济.信息技术的迅速发展,知识资源成为企业无形资产的重要组成部分. 目前,企业的核心竞争力不仅取决于企业的硬件设备.资金实力.资源数量和人员数量,还取决于企业对知识的掌握.运用.传承和创新. 建立 ...

最新文章

热门文章