dosify一个神奇的文档网站生成工具

Laughing
2022-09-21 / 0 评论 / 841 阅读 / 正在检测是否收录...
温馨提示:
本文最后更新于2024年03月15日,已超过309天没有更新,若内容或图片失效,请留言反馈。

之前一直使用的觅思文档作为内部在线知识库。公司内部最近在进行服务器漏洞扫描,觅思文档使用的Python+Django的形式(我用的Docker一键部署的那个,看Python的版本好像是3.7.3吧),由于Python注入漏洞影响3.10.4及以下版本,所以我尝试将Python升级到3.10.7,但是由于Django与Python版本对应关系存在问题,所以升级以失败告终。也是出于无奈,只能另寻其他替代产品。
经过对比,选择了一款小巧的文档网站生成工具-dosify。

一、docsify的优缺点

1.1、优点

  • 简洁,没有乱七八糟的功能,也不需要复杂的配置
  • 部署简单,两三条命令即可完成部署,不需要数据库
  • 结构化展示,直接展示本地markdown文件

1.2、缺点

  • 没有用户管理功能,不方便多人协作
  • 因为是本地化部署,所以不方便使用七牛等图床,导致markdown文件中粘贴图片不是很方便。(当然,我们可以通过typora配置图片上传路径解决此问题)

二、docsify部署

首先确保已安装node.js。

2.1、安装docsify-cli

推荐全局安装docsify-cli工具,可以方便地创建及在本地预览生成的文档。
打开终端,执行以下命令

npm i docsify-cli -g

2.2、初始化项目

新建文件夹,文件夹名称随意起(我创建了docsify),然后在终端进入文件夹
在终端输入

docsify init

然后查看文件夹

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

    运行

    直接输入

    docsify serve

    即可运行项目
    默认端口是3000
    此时网站就搭建成功了。
    如果我们需要编辑网站的内容,可以直接修改README.md文件。
    如果需要修改端口,直接运行

    socsify server -p 端口号

    关于docsify的一些其他配置,比如更换主题、设置封面、安装插件等,我们稍后在进行介绍。

0

评论 (0)

取消