使用Docsify做文档网站详细教程解决方案

长什么样

一上来就说这个有多好,鬼才信你,有图有真相,自己看。
另外 Docsify官方演示链接:https://docsify.js.org/

首页一张图开局
首页
内容界面简单
在这里插入图片描述

优势

  1. 自带封面还可以修改,颜值就看自己的水平。
  2. 界面简单,左侧导航栏,右侧内容,标准文档格式。
  3. 全Markdown 语言支持,写完文档还可以发到各个主流网站。
  4. 还有主题提供。

Node.js 安装

Docsify 安全依赖于node.js,所以必须先安装node.js,选哪个都可以,下载后一路下一步即可。
下载链接 https://nodejs.org/en/
在这里插入图片描述

本地搭建

  1. 进入windows CMD 命令窗口,建议用管理员权限开启
    在这里插入图片描述
  2. 利用npm安装dicsify 插件
npm i docsify-cli -g 

   
   
  • 1

在这里插入图片描述

  1. 开始利用 docsify 命令部署网站
docsify init ./docs

   
   
  • 1

执行此命令时需要进入到自己指定文件夹,完成后会添加docs文件夹,如下图:

在这里插入图片描述

  1. 网站发布
    在cmd命令行中执行如下命令即可开启网站,浏览http://localhost:3000
docsify serve docs

   
   
  • 1

在这里插入图片描述
这跟网站演示天差地别嘛,不要担心,学习更精进的文档即可超越官方演示。
在这里插入图片描述

常见问题

如果遇到docsify 命令无法开启时,需要增加如下路径到环境变量path内。
在这里插入图片描述

遇到使用nmp安装好docsify-cli后,欲查看其版本信息,却报错: docsify : 无法加载文件 C:\Users\86152\AppData\Roaming\npm\docsify.ps1, 因为在此系统上禁止运行脚本。

具体为:
在这里插入图片描述

解决方法:

  1. 选择管理员身份打开
  2. 输入set-ExecutionPolicy RemoteSigned
  3. 选择Y,进行更改策略
图示

如果在非Internet环境下安装,部署好的网站不会显示,问题出在css和js文件上,原html文件是网络链接的方式导入css样式,
在这里插入图片描述
进入链接会发现css,ctrl+A,粘贴并生成新的css和min.js。
在这里插入图片描述新存储的css和js放到根目录:在这里插入图片描述更改htmlcss和js为本地文件链接,即可解决无外网状况下一直loading……的问题。在这里插入图片描述

专业文档推荐

最专业的文档就是docsfy演示网站的内容,https://docsify.js.org/#/zh-cn/
其次推荐Xhemj 的bolg内容, https://www.cnblogs.com/xhemj/p/How-to-Use-Docsify.html

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值