2 Star 25 Fork 9

teedoc / teedoc

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

teedoc

中文 | English

License PyPI PyPI - Downloads PyPI - Downloads GitHub Repo stars

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

更多样例: 看这里这里

Markdown 或者 Jupyter Notebook 格式的文档转换为 HTML 网页

以下场景可使用teedoc

  • 建文档网站,并且最好支持放多份文档,和自定义页面
  • 组织或者企业有很多份文档分散在各个域名,希望统一到一个域名下
  • WiKi网站
  • 建个人或者企业知识库
  • 建个人或者企业网站

Features

  • 使用简单, 跨平台,只依赖 Python3
  • 部署简单, 生成的网站是全静态页面,直接拷贝到服务器或者上传到三方机构即可部署
  • 书写简单,使用 Markdown 语法编写
  • Jupyter notebook 支持
  • 多文档支持
  • 插件支持
  • 多主题支持(由插件实现)
  • 通过 css 控制精确到页的样式(通过自定义每页的 id 和 class 实现)
  • 多级目录支持
  • 多语言支持(手动翻译)(国际化/i18n)
  • 多语言支持(翻译插件)
  • 搜索支持
  • SEO 友好
  • 实时预览更改
  • 并行构建,更快的构建速度
  • 博客支持
  • Jinja2 HTML 布局模板支持

开始使用吧

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

几分钟内在 github pages 服务上搭建你自己的网站

查看 template 仓库

快速开始

  • 安装 python3

WindowsmacOS, 从 python.org 下载安装包安装

Linux, 如 Ubuntu:

sudo apt install python3 python3-pip
  • 安装 teedoc

这条命令会 安装 teedoc 主程序

pip3 install -U teedoc
  • 初始化文档
mkdir my_site
cd my_site
teedoc init

或者

teedoc -d my_site init

根据提示选择 minimal 模板

  • 安装插件

这条命令会 安装文档需要的插件(在site_config.json里设置)

cd my_site
teedoc install
  • 构建(build) 或者 预览(serve
teedoc serve

然后浏览器访问 http://127.0.0.1:2333

如果只需要构建生成网页:

teedoc build
MIT License Copyright (c) 2021 Neucrack CZD666666@gmail.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

静态网站/文档网站生成工具,快速使用 markdown 或者 jupyter notebook 编写并生成 html 文档网站,建官网和文档以及知识库均适用,使用 python 编写,无需数据库,轻量稳定实用。可替代gitbook。 https://github.com/teedoc/teedoc 展开 收起
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Python
1
https://gitee.com/teedoc/teedoc.git
git@gitee.com:teedoc/teedoc.git
teedoc
teedoc
teedoc
main

搜索帮助

14c37bed 8189591 565d56ea 8189591