中文 README | English README
此模板使用于 teedoc: teedoc.neucrack.com 或 teedoc.github.io learn more
- 安装 python3
Windows 或 macOS, 从 python.org 下载安装包安装
Linux, 如 Ubuntu:
sudo apt install python3 python3-pip
- 安装 teedoc
这条命令会 安装 teedoc 主程序
pip3 install teedoc
- 初始化文档
mkdir my_site
cd my_site
teedoc init
或者
teedoc -d my_site init
- 安装插件
这条命令会 安装文档需要的插件(在site_config.json里设置)
cd my_site
teedoc install
- 构建（
build） 或者 预览（serve）
teedoc serve
然后浏览器访问 http://127.0.0.1:2333
如果只需要构建生成网页:
teedoc build
- 访问 https://github.com/teedoc/template or https://github.com/teedoc/teedoc.github.io， 点击
Use this template
- 设置新仓库的名字为
用户名或者组织名.github.io, 选择公开仓库, 然后确认提交
之后使用
git clone 你的仓库地址就可以克隆到本地了
- 等待自动构建生成新的分支
gh-pages, 可以点击Actions栏目查看自动构建的进度, 如果有绿色的勾勾出现了就代表可以了, 如果出现了红色的叉叉则是构建失败了, 哪里出了什么问题, 可以按照下面的截图方法点进去查看日志(提交问题必须要日志截图)并提交 issue 反馈
如果有错误, 可以按照下图点进去查看错误日志:
-
设置仓库的
pages服务, 选择gh-pages分支, 如果没有这个分支, 则是上一步还没进行完或者出错了,可以查看问题提交 issue 反馈
-
然后访问
用户名或者组织名.github.io, 就会发现有网页啦, 内容和teedoc.github.io的一模一样!
