doc site generator with multiple doc support
Project description
teedoc
Official site: teedoc.github.io
documentation generate tool from markdown and jupyter notebook to html
Features
- Easy to use, cross platform, only need
Python3
- Easy to write, markdown support
- Jupyter notebook support
- Multiple docs support
- Plugin support
- Multiple theme support(support by plugin)
- Multi-level directory support
- Multiple language support(manually translate)
- Multiple language support(auto translate)
- Multiple version support
- Search support
- SEO friendly
- Real-time preview file changes
- Blog support
Usage
Install Python3
first, only support Python3.7
or higher version
e.g. on Ubuntu
:
sudo apt install python3 python3-pip
Windows
or macOS
just visit Python official site
Install
pip3 install teedoc
And upgrade with command:
pip3 install teedoc --upgrade
now you can use teedoc
command
if not, ensure python3 bin path in your env PATH,
e.g. ~/.local/bin
Build website
- Get template site source code
git clone https://github.com/teedoc/teedoc.github.io my_site
- Install pulgins
cd my_site
teedoc install
- Build
HTML
pages and start aHTTP
server
teedoc serve
After show Starting server at 0.0.0.0:2333 ....
Open brower visit: http://127.0.0.1:2333
or only build
teedoc build
then you can find website in out
directory
More see teedoc.github.io
Project details
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
teedoc-1.3.4.tar.gz
(17.6 kB
view hashes)
Built Distribution
teedoc-1.3.4-py3-none-any.whl
(17.8 kB
view hashes)