Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teedoc/teedoc
wiki and multi docs friendly static document site generator(doc generator), convert markdown and jupyter notebook to html website. wiki 和多文档友好的静态文档网站生成工具
https://github.com/teedoc/teedoc
doc docs generator generators html jupyter markdown multi python site teedoc website wiki
Last synced: 2 days ago
JSON representation
wiki and multi docs friendly static document site generator(doc generator), convert markdown and jupyter notebook to html website. wiki 和多文档友好的静态文档网站生成工具
- Host: GitHub
- URL: https://github.com/teedoc/teedoc
- Owner: teedoc
- License: mit
- Created: 2021-01-16T12:50:16.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-11T02:23:11.000Z (3 months ago)
- Last Synced: 2024-10-29T17:21:48.153Z (3 months ago)
- Topics: doc, docs, generator, generators, html, jupyter, markdown, multi, python, site, teedoc, website, wiki
- Language: CSS
- Homepage: https://teedoc.neucrack.com
- Size: 2.67 MB
- Stars: 211
- Watchers: 4
- Forks: 21
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: history.md
- License: LICENSE
Awesome Lists containing this project
README
teedoc
===========
[中文](./README_ZH.md) | English
[](./LICENSE) [](https://pypi.org/project/teedoc/#history)   [](https://github.com/teedoc/teedoc/actions/workflows/test.yml) [](https://github.com/teedoc/teedoc)
Official site: [teedoc.neucrack.com](https://teedoc.neucrack.com) or [teedoc.github.io](https://teedoc.github.io/)
More demo: see [here](https://teedoc.neucrack.com/get_started/zh/usage/sites.html) or [here](https://teedoc.github.io/get_started/zh/usage/sites.html)
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
- [x] Easy to use, cross platform, only need `Python3`
- [x] Easy to deploy, only copy generated staitc HTML files to your server or other host
- [x] Easy to write, markdown support
- [x] Jupyter notebook support
- [x] Multiple docs support
- [x] Plugin support
- [x] Multiple theme support(support by plugin)
- [x] Control the style accurate to the page through css (implemented by customizing the id and class of each page)
- [x] Multi-level directory support
- [x] Multi-language support (manual translation) (Internationalization/i18n)
- [x] Multilingual support (translation plugin)
- [x] Multiple version support
- [x] Search support
- [x] SEO friendly
- [x] Real-time preview file changes
- [x] Parallel build, faster build speed
- [x] Blog support
- [x] Jinja2 HTML layout template support
## Get Started
Visit official site: [teedoc.github.io](https://teedoc.github.io/) or [teedoc.neucrack.com](https://teedoc.neucrack.com/)
## Create your website on github pages in minutes
See [template repo](https://github.com/teedoc/template)
## Quik start
* Install python3
On `Windows` or `macOS`, download from [python.org](https://www.python.org/downloads/)
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](http://127.0.0.1:2333) in browser
If you only want to generate htmls:
```
teedoc build
```