2 Star 29 Fork 11

teedoc/teedoc

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
MIT

teedoc

中文 | English

License PyPI PyPI - Downloads PyPI - Downloads build GitHub Repo stars

Official site: teedoc.neucrack.com or teedoc.github.io

More demo: see here or here

documentation generate tool from markdown and jupyter notebook to html

teedoc can be used in the following scenarios:

  • Build a document website, and it is best to support multiple documents and custom pages
  • Organizations' or companies' docs spread in different domains, wish to combine them to one site(domain)
  • Build a WiKi website
  • Build personal or corporate knowledge base
  • Build personal or corporate website

Features

  • Easy to use, cross platform, only need Python3
  • Easy to deploy, only copy generated staitc HTML files to your server or other host
  • Easy to write, markdown support
  • Jupyter notebook support
  • Multiple docs support
  • Plugin support
  • Multiple theme support(support by plugin)
  • Control the style accurate to the page through css (implemented by customizing the id and class of each page)
  • Multi-level directory support
  • Multi-language support (manual translation) (Internationalization/i18n)
  • Multilingual support (translation plugin)
  • Multiple version support
  • Search support
  • SEO friendly
  • Real-time preview file changes
  • Parallel build, faster build speed
  • Blog support
  • Jinja2 HTML layout template support

Get Started

Visit official site: teedoc.github.io or teedoc.neucrack.com

Create your website on github pages in minutes

See template repo

Quik start

  • Install python3

On Windows or macOS, download from python.org

On Linux, Ubuntu for example:

sudo apt install python3 python3-pip
  • Install teedoc

This command will install teedoc program

pip3 install -U teedoc
  • Initialize document
mkdir my_site
cd my_site
teedoc init

or

teedoc -d my_site init

select minimal template in promot

  • Install plugins

This command will install plugins used by doc(set in site_config.json)

cd my_site
teedoc install
  • build or serve
teedoc serve

then visit http://127.0.0.1:2333 in browser

If you only want to generate htmls:

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.

About

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

Releases

No release

Contributors

All

Activities

Load More
can not load any more
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Python
1
https://gitee.com/teedoc/teedoc.git
git@gitee.com:teedoc/teedoc.git
teedoc
teedoc
teedoc
main

Search

344bd9b3 5694891 D2dac590 5694891