Github+docsify +Typora 免费构建自己的文档网站
docsify :可以直接将Markdown文件解析到网站上面去,启动后,上传的Markdown文件,不需要重启服务器。
优点:
- 无需构建,写完文档直接发布
- 容易使用并且轻量 (~19kB gzipped)
- 智能的全文搜索
- 提供多套主题
- 丰富的 API
- 支持 Emoji
- 兼容 IE10+
- 支持 SSR (example)
Typora :是我最喜欢的一个Markdown文本编辑器
使用docsify搭建文档网站步骤:
-
安装npm : 可通过nvm安装
nvm 安装:curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.8/install.sh | bash
查看nvm的版本说明安装成功 : nvm -v
安装指定版本的nodejs: nvm install version
-
安装docsify-cli : npm i docsify-cli -g
-
初始化项目:docsify init ./docs
初始化成功后,可以看到
./docs目录下创建的几个文件index.html入口文件README.md会做为主页内容渲染.nojekyll用于阻止 GitHub Pages 会忽略掉下划线开头的文件
直接编辑
docs/README.md就能更新网站内容,当然也可以写多个页面。 -
本地预览网站: docsify serve ./docs
运行一个本地服务器通过
docsify serve可以方便的预览效果,而且提供 LiveReload 功能,可以让实时的预览。默认访问 http://localhost:3000 。
部署GitHub
如果要绑定自己的域名的话:在自己的域名服务商的域名解析页面添加一条CNAME记录:
GitHub在验证通过之后,会自动在项目中添加一个CNAME文件
官方中文文档