Skip to content

Commit 4d7ed6d

Browse files
committed
add site generator teedoc
1 parent 1d17a5b commit 4d7ed6d

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

src/site/generators/teedoc.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: teedoc
3+
repo: teedoc/teedoc
4+
homepage: https://teedoc.github.io
5+
language:
6+
- Python
7+
license:
8+
- MIT
9+
templates:
10+
- Markdown
11+
- Jupyter notebook
12+
description: A document site generator, Convert documents in Markdown or Jupyter Notebook format into HTML static web pages
13+
---
14+
15+
16+
17+
Official website: [teedoc.neucrack.com](https://teedoc.neucrack.com/) or [teedoc.github.io](https://teedoc.github.io/)
18+
Source code: [https://github.com/teedoc/teedoc](https://github.com/teedoc/teedoc)
19+
20+
Convert documents in `Markdown` or `Jupyter Notebook` format into `HTML` static web pages
21+
22+
`teedoc` can be used in the following scenarios:
23+
* Build a document website, and it’s best to support multiple documents and custom pages
24+
* Build a `WiKi` website
25+
* Build a personal or corporate knowledge base
26+
* Build a personal or corporate website
27+
* Blog
28+
29+
30+
## Features
31+
32+
- [x] Simple to use, cross-platform, only dependent on `Python3`
33+
- [x] No database required, all static pages of the website
34+
- [x] The deployment is simple, the generated website is a fully static page, which can be directly copied to the server or uploaded to a third party organization for deployment
35+
- [x] Easy to write, using Markdown syntax
36+
- [x] Jupyter notebook support
37+
- [x] HTML support, you can directly use HTML to write pages, with great freedom
38+
- [x] Multi-document support
39+
- [x] Plug-in support
40+
- [x] Multi-theme support (implemented by plug-in)
41+
- [x] Control the style accurate to the page through css (implemented by customizing the id and class of each page)
42+
- [x] Multi-level directory support
43+
- [x] Multi-language support (manual translation) (Internationalization/i18n)
44+
- [x] Multi-version support (implementation method is the same as multi-language)
45+
- [x] Search support
46+
- [x] SEO friendly
47+
- [x] Real-time preview of changes
48+
- [x] Multi-threaded construction, faster construction speed
49+
- [x] Blog support
50+
51+
## Demo
52+
53+
[Official website](https://teedoc.github.io/) is generated using `teedoc`, what you see now is what the generated website looks like.
54+
55+
In addition, there are other websites that use `teedoc`, please see [here](https://teedoc.github.io/get_started/en/usage/sites.html) for details
56+

0 commit comments

Comments
 (0)