通过Docsify搭建markdown文件服务器

一、Docsify简介

Docsify 是一个动态生成文档网站的工具,如果只是需要快速的搭建一个小型的文档网站,这将非常实用。
官网:https://docsify.js.org/#/zh-cn/quickstart

二、用法

1、安装脚手架工具 docsify-cli
$ npm i docsify-cli -g

2、初始化文档
$ docsify init docs
注意这里的文件名约定为 docs 也是官方推荐

执行完以上命令 docs 文件目录下会生成以下 3 个文件:

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

3、运行
$ docsify serve test

4、测试访问
$ curl http://localhost:3000

5、nginx转发代理配置

server {
  listen 80;
  server_name docs.tangxiaoyang.vip;
  index index.html index.htm index.jsp;


  location ~ {
    proxy_pass http://127.0.0.1:6283;
    proxy_redirect off;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
  }
}

注意还要重启nginx
$ nginx -s reload

最后,附上我的在线文档访问地址:http://docs.tangxiaoyang.vip

  • 2
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 9
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 9
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

IT教育-汤小洋

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值