doc site generator with multiple doc support
Project description
teedoc
中文 | English
Official site: teedoc.neucrack.com or teedoc.github.io
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
WiKiwebsite - 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file teedoc-1.27.0.tar.gz.
File metadata
- Download URL: teedoc-1.27.0.tar.gz
- Upload date:
- Size: 852.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4ee11a34e70423e1cb0f774f6d333cd49e2148120e3077a618122ddbedf1db9a |
|
| MD5 | 10ad63c8c08ff0ed672977d3cf1f3739 |
|
| BLAKE2b-256 | 76a0afba46be877028d2f522721a7d6b322a69f2ed8696f99b1ab1a8e793776b |
File details
Details for the file teedoc-1.27.0-py3-none-any.whl.
File metadata
- Download URL: teedoc-1.27.0-py3-none-any.whl
- Upload date:
- Size: 863.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 33267ce6cf07d0e998119ec6aa62b74368de46a8fc3db8092cc512e0260cfc08 |
|
| MD5 | 3365467ab9a7e04682b8f0331e737c34 |
|
| BLAKE2b-256 | 4a04f0df64bf0c35636d1ab12882630d4482568ebb4cb9088d18ad7ffa9c50e0 |
