teedoc 项目教程

teedoc 项目教程

teedoc wiki and multi docs friendly static document site generator(doc generator), convert markdown and jupyter notebook to html website. wiki 和多文档友好的静态文档网站生成工具 项目地址: https://gitcode.com/gh_mirrors/te/teedoc

1. 项目的目录结构及介绍

teedoc 项目的目录结构如下：

teedoc/
├── assets/
│   └── images/
├── examples/
│   └── local_test/
├── plugins/
├── teedoc/
├── .gitignore
├── .gitmodules
├── LICENSE
├── MANIFEST.in
├── README.md
├── README_ZH.md
├── history.md
├── release.py
├── requirements.txt
└── setup.py

目录结构介绍

• assets/: 存放项目所需的静态资源文件，如图片等。
• examples/: 存放项目的示例代码或测试代码。
• plugins/: 存放项目的插件文件。
• teedoc/: 项目的主要代码文件夹。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• LICENSE: 项目的开源许可证文件。
• MANIFEST.in: 项目的打包配置文件。
• README.md: 项目的英文介绍文件。
• README_ZH.md: 项目的中文介绍文件。
• history.md: 项目的历史记录文件。
• release.py: 项目的发布脚本。
• requirements.txt: 项目的依赖包列表。
• setup.py: 项目的安装脚本。

2. 项目的启动文件介绍

teedoc 项目的启动文件主要是 setup.py 和 release.py。

setup.py

setup.py 是 Python 项目的标准安装脚本，用于安装项目的依赖包和配置项目。通过运行以下命令可以安装 teedoc：

pip3 install -U teedoc

release.py

release.py 是项目的发布脚本，用于生成项目的发布版本。通常在项目发布新版本时使用。

3. 项目的配置文件介绍

teedoc 项目的主要配置文件是 site_config.json，该文件通常位于项目的根目录下。

site_config.json

site_config.json 文件包含了项目的各种配置信息，如文档的路径、插件的配置、主题的配置等。以下是一个示例配置文件的内容：

{
    "site_name": "teedoc",
    "site_url": "https://teedoc.github.io/",
    "docs": [
        {
            "name": "doc1",
            "path": "docs/doc1"
        },
        {
            "name": "doc2",
            "path": "docs/doc2"
        }
    ],
    "plugins": {
        "theme": "default",
        "search": "true"
    }
}

配置项介绍

• site_name: 网站的名称。
• site_url: 网站的URL。
• docs: 文档的配置列表，每个文档包含 name 和 path 两个字段。
• plugins: 插件的配置，如主题和搜索插件的配置。

通过修改 site_config.json 文件，可以自定义 teedoc 项目的各种配置。

teedoc wiki and multi docs friendly static document site generator(doc generator), convert markdown and jupyter notebook to html website. wiki 和多文档友好的静态文档网站生成工具 项目地址: https://gitcode.com/gh_mirrors/te/teedoc