怎么搭建企业知识库? 您所在的位置:网站首页 ssr怎么搭建 怎么搭建企业知识库?

怎么搭建企业知识库?

2023-04-13 11:23| 来源: 网络整理| 查看: 265

在线知识库地址前言

  网上关于动态文档生成工具有很多如:Docsify、 VuePress、Docute 、Hexo这些都是一些非常优秀的文档生成工具,本章主要介绍如何快速使用Docsify搭建一个快捷、轻量级的个人&团队文档。

什么是Docsify?

  一个神奇的文档网站生成器。docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件,所有转换工作都是在运行时。如果你想要开始使用它,只需要创建一个 index.html 就可以开始编写文档。

Docsify的特性无需构建,写完文档直接发布容易使用并且轻量 (压缩后 ~21kB)智能的全文搜索提供多套主题丰富的 API支持 Emoji兼容 IE11支持服务端渲染 SSR (示例)轻量&完善的Docsify模板

  该模板为一个简洁,并且完善的Docsify模板基本上可以满足百分之八十多的团队需求,你可以按照文章中的Docsify环境配置教程把运行Docsify所需要的环境配置起来,通过命令即可查看效果(配置环境顺利的话只要十来分钟)。

模板源码地址:Docsify-Guide 模板预览地址:https://ysgstudyhards.github.io/Docsify-Guide/#/ Node.js 安装配置nodejs下载地址Node.js最新最详细安装教程

win+r:cmd进入命令提示符窗口,分别输入以下命令查看node和npm的版本能够正常显示版本号,则安装成功:

node -v:显示安装的nodejs版本npm -v:显示安装的npm版本docsify-cli工具安装推荐全局安装 docsify-cli 工具,可以方便地创建及在本地预览生成的文档。

npm i docsify-cli -g

项目初始化如果想在项目的 ./docs(文件名可以按自己的想法来) 目录里写文档,直接通过 init 初始化项目。docsify init ./Docsify-Guide

初始化成功后,可以看到 ./docs 目录下创建的几个文件

index.html 入口文件README.md 会做为主页内容渲染.nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件

直接编辑 docs/README.md 就能更新文档内容,当然也可以添加更多页面。

本地运行docsify创建的项目通过运行 docsify serve 项目名称 启动一个本地服务器,可以方便地实时预览效果。默认访问地址 http://localhost:3000 。docsify serve Docsify-Guide基础配置文件介绍其实我们维护一份轻量级的个人&团队文档我们只需要配置以下这几个基本文件就可以了。文件作用文件基础配置项(入口文件)index.html封面配置文件_coverpage.md侧边栏配置文件_sidebar.md导航栏配置文件_navbar.md主页内容渲染文件README.md浏览器图标favicon.ico基础配置项(index.html)下面是一份基础的配置项模板如下(可直接Copy使用)。 Docsify-Guide 加载中... window.$docsify = { // 项目名称 name: 'Docsify-Guide', // 仓库地址,点击右上角的Github章鱼猫头像会跳转到此地址 repo: 'https://github.com/YSGStudyHards', // 侧边栏支持,默认加载的是项目根目录下的_sidebar.md文件 loadSidebar: true, // 导航栏支持,默认加载的是项目根目录下的_navbar.md文件 loadNavbar: true, // 封面支持,默认加载的是项目根目录下的_coverpage.md文件 coverpage: true, // 最大支持渲染的标题层级 maxLevel: 5, // 自定义侧边栏后默认不会再生成目录,设置生成目录的最大层级(建议配置为2-4) subMaxLevel: 4, // 小屏设备下合并导航栏到侧边栏 mergeNavbar: true, /*搜索相关设置*/ search: { maxAge: 86400000,// 过期时间,单位毫秒,默认一天 paths: 'auto',// 注意:仅适用于 paths: 'auto' 模式 placeholder: '搜索', // 支持本地化 placeholder: { '/zh-cn/': '搜索', '/': 'Type to search' }, noData: '找不到结果', depth: 4, hideOtherSidebarContent: false, namespace: 'Docsify-Guide', } } 封面配置文件(_coverpage.md)Docsify官网封面配置教程index.html window.$docsify = { coverpage: true }

_coverpage.md

# Docsify使用指南 > Docsify使用指南,使用Typora+Docsify打造最强、最轻量级的个人&团队文档。 简单、轻便 (压缩后 ~21kB) - 无需生成 html 文件 - 众多主题 [开始使用 Let Go](/README.md)侧边栏配置文件(_sidebar.md)Docsify官网配置侧边栏教程index.html window.$docsify = { loadSidebar: true } 在index.html基础配置文件中设置了二级目录

_sidebar.md

* Typora+Docsify使用指南 * [Docsify使用指南](/ProjectDocs/Docsify使用指南.md) * [Typora+Docsify快速入门](/ProjectDocs/Typora+Docsify快速入门.md) * Docsify部署 * [Docsify部署教程](/ProjectDocs/Docsify部署教程.md)导航栏配置文件(_navbar.md)Docsify官网配置导航栏教程index.html window.$docsify = { loadNavbar: true }

_navbar.md

* 链接到我 * [关于本人](https://mp.weixin.qq.com/s/dCyKG6n6l5ICTl24dKNqbw) * [博客园地址](https://www.cnblogs.com/Can-daydayup/) * [Github地址](https://github.com/YSGStudyHards) * [知乎地址](https://www.zhihu.com/people/ysgdaydayup) * [掘金地址](https://juejin.cn/user/2770425031690333/posts) * [Gitee地址](https://gitee.com/ysgdaydayup) * 友情链接 * [Docsify](https://docsify.js.org/#/) * [博客园](https://www.cnblogs.com/)全文搜索 - Search全文搜索 - Search Docsify主题切换注意:切换主题只需要在根目录的index.html切换对应的主题css文件即可

详情参考:https://docsify.js.org/#/zh-cn/themeshttps://github.com/YSGStudyHards/Docsify-Guide/blob/main/ProjectDocs/Docsify%E9%83%A8%E7%BD%B2%E6%95%99%E7%A8%8B.md

GitHub Pages

GitHub Pages 支持从三个地方读取文件

docs/ 目录master 分支gh-pages 分支

我们推荐直接将文档放在 docs/ 目录下,在设置页面开启 GitHub Pages 功能并选择 master branch /docs folder 选项。

可以将文档放在根目录下,然后选择 master 分支 作为文档目录。你需要在部署位置下放一个 .nojekyll 文件(比如 /docs 目录或者 gh-pages 分支)

Docsify详细部署教程Docsify部署教程 相关教程docsify-github地址docsify快速开始-官方教程使用开源文档工具docsify,用写博客的姿势写文档


【本文地址】

公司简介

联系我们

今日新闻

    推荐新闻

    专题文章
      CopyRight 2018-2019 实验室设备网 版权所有