• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

teedoc: 静态网站/文档网站生成工具,快速使用 markdown 或者 jupyter notebook 编写 ...

原作者: [db:作者] 来自: 网络 收藏 邀请

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_sitecd my_siteteedoc init

或者

teedoc -d my_site init

根据提示选择 minimal 模板

  • 安装插件

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

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

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

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

teedoc build

鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
上一篇:
dumi: 发布时间:2022-02-13
下一篇:
swaggerLUI: SwaggerLUI 是一款开源的接口调试、文档管理工具,基于swagger扩展,使用 ...发布时间:2022-02-13
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap