teedoc 安装使用

    安装 python3

    需要先安装Python3 （仅支持 Python3）

    比如在Ubuntu上：

    sudo apt install python3 python3-pip git

    Windows 和 macOS请到官网下载

    安装 teedoc

    打开终端，输入：

    pip3 install teedoc

    以后使用以下命令来更新软件：

    pip3 install teedoc --upgrade

    如果你的网络使用 pypi.org 速度很慢，可以选择其它源，比如清华 tuna 源： pip3 install teedoc -i https://pypi.tuna.tsinghua.edu.cn/simple

    现在你可以在终端使用 teedoc 命令了

    如果不能，请检查是不是Python可执行目录没有加入到环境变量 PATH,
    比如可能在 ~/.local/bin

    新建工程

    新建一个空目录用来放文档工程

    mkdir my_site
cd my_site
teedoc init

    这会在 my_site 目录下自动生成一些基础文件

    另外，除了使用init命令生成一份最小工程，你也可以获得一份官网文档源码，基于这个文档内容修改

    git clone https://github.com/teedoc/teedoc.github.io my_site

    或者

    git clone https://gitee.com/teedoc/teedoc.gitee.io my_site

    安装插件

    这会根据site_config.sjon中的plugins的插件设置安装插件

    cd my_site
teedoc install

    插件也是以 python 包的形式发布的， 所以这会从 pypi.org 下载对应的插件，同样，也可以使用其它源，比如清华 tuna 源： teedoc -i https://pypi.tuna.tsinghua.edu.cn/simple install

    构建 HTML 页面并起一个HTTP服务

    teedoc serve

    这个命令会先构建所有HTML页面以及拷贝资源文件，然后起一个HTTP服务
    如果只需要生成页面，使用

    teedoc build

    在显示 Starting server at 0.0.0.0:2333 .... 后，就可以了

    打开浏览器访问: http://127.0.0.1:2333

    同时可以看到目录下多了一个out目录，里面就是生成的静态网站内容，直接拷贝到服务器使用nginx或者apache进行部署即可

    在 github 上基于模板仓库创建新仓库

    访问 https://github.com/teedoc/teedoc.github.io

    点击 Use this template

    github use template

    然后填写新的仓库名称和描述，基于这个仓库新建一个你自己的仓库，现在你获得了和 teedoc官网一模一样的仓库了

    然后使用git clone 你的仓库地址就可以克隆到本地了