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
1 maintainer
Metadata
1 maintainer
Release files for teedoc 1.37.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| teedoc-1.37.9.tar.gz | 846.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| teedoc-1.37.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.7 MB
Release files / teedoc-1.37.9.tar.gz
| Download URL | teedoc-1.37.9.tar.gz |
|---|---|
| Size | 846.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7a7124003663c3c8d46a9302fc8cc4efa7341efae585c3464b2da2d621c614b1
|
|
BLAKE2b-256 checksum How to use checksums |
24b8ec9a980521412b03b35acb72f1d107f3fe446ca264d0af90869430d79b18
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.10.12
|
Release files / teedoc-1.37.9-py3-none-any.whl
| Download URL | teedoc-1.37.9-py3-none-any.whl |
|---|---|
| Size | 856.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6cba2daaa88ace688fe04b9ba18127a927fc1fd25ff4a0869a192acc8bebec79
|
|
BLAKE2b-256 checksum How to use checksums |
fefffdbec24957bfde6d040b75d93173bd91b8a4314d9a47cbfeb8cd6482c59c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.10.12
|
