wiki网站搭建

基本架构

使用 teedoc框架搭建，使用github的pages部署而成。

teedoc介绍

简而全的开源静态网站/文档/博客生成器

1. 使用 Markdown 或者 jupyter notebook 书写，自动生成 HTML 页面

2. 使用 python 编写， 跨平台， 使用 pip 即可安装， 支持插件安装及自定义插件

3. 支持多文档，每篇文档有单独的目录，也可以多版本。你的大量文档再也不用散落在各个域名下了！同时支持轻量博客系统

4. 默认主题为高效阅读而设计，提供主题插件支持，同时支持自定义 css、js，能通过页面指定 id 精确控制任何一个页面元素的样式

5. 并行构建，充分利用处理器性能，文档渲染就在一瞬间，支持浏览器实时预览修改

6. 生成的都是静态页面，拷贝到服务器即可完成部署，SEO 友好，比如 页关键词自定义、sitemap自动生成等

teedoc相关资料

官网: teedoc.neucrack.com 或 teedoc.github.io

本文档源文件: github.com/teedoc/teedoc.github.io

源码: https://github.com/teedoc/teedoc 如果你喜欢这个项目，请务必登录 github 给项目点个 star

以下场景可使用teedoc：

• 建文档网站，并且最好支持放多份文档（比如你有一本叫Python学习和C++学习两本书，它们都有单独的目录, teedoc则是书库）
• 文档和网页页面共存，支持自定义HTML页面
• 建WiKi网站
• 建个人或者企业知识库
• 建个人或者企业网站
• 博客

使用teedoc的企业案例

期待你的使用， 欢迎提交 issue 或者 PR 来添加你的网站

快速搭建wiki网站

安装 python3

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

比如在Ubuntu上：

sudo apt install python3 python3-pip git

Windows 和 macOS请到官网下载

安装 teedoc

打开终端(Windows按Ctrl+R输入cmd)，输入：

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

选择1，也就是minimal模板进行生成， 也可以直接teedoc -d my_site --template=minimal init进行生成

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

安装插件

这会根据site_config.json中的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进行部署即可