diff --git a/_tools/teedoc.md b/_tools/teedoc.md new file mode 100644 index 000000000..9edd510c1 --- /dev/null +++ b/_tools/teedoc.md @@ -0,0 +1,137 @@ +--- +title: teedoc +category: "websites" +description: "Static doc site generator from Markdown and jupyter, written with Python." +icon: teedoc.png +website: https://teedoc.github.io +syntax: + - id: headings + available: y + - id: paragraphs + available: y + - id: line-breaks + available: y + - id: bold + available: y + - id: italic + available: y + - id: blockquotes + available: y + - id: ordered-lists + available: y + - id: unordered-lists + available: y + - id: code + available: y + - id: horizontal-rules + available: y + - id: links + available: y + - id: images + available: y + - id: tables + available: y + - id: fenced-code-blocks + available: y + - id: syntax-highlighting + available: y + - id: footnotes + available: y + - id: heading-ids + available: y + - id: definition-lists + available: y + - id: strikethrough + available: y + - id: task-lists + available: y + - id: emoji-cp + available: y + - id: emoji-sc + available: n + - id: highlight + available: n + - id: subscript + available: y + - id: superscript + available: y + - id: auto-url-linking + available: y + - id: disabling-auto-url + available: y + - id: html + available: y +see-also: + - name: teedoc Markdown Features + link: https://teedoc.github.io/get_started/en/syntax/syntax_markdown.html +--- + +[teedoc](https://teedoc.github.io) is an open-source static site generator that converts Markdown files and jupyter notebooks to a documentation website. teedoc is written in the Python programming language, easy to use and extend. + +teedoc especially suitable for multiple documentation sites or wiki, or knowledge bases. + +teedoc uses the [mistune](https://github.com/lepture/mistune) Markdown parser. + +{% include image.html file="/assets/images/tools/teedoc.png" alt="Example of teedoc website" %} + +{% include tool-syntax-table.html %} + +### Support for Additional Syntax Elements + +teedoc support many useful additional syntax like: +* [mermaid](https://mermaid-js.github.io/mermaid/): A simple markdown-like script language for generating charts from text via javascript. +* math: Support Latex and tex math syntax, and MathML tags. +* tabset: A easy to use tabset syntax. For example: to show different code examples for different programming languages. + ```markdown + .. tabset:: + :id: tabset1 + + ## Kotlin + + Content 1, full Markdown syntax support + + ## Java + + Content 2, full Markdown syntax support + ``` + + will be rendered to: + ```html +
Content 1, full Markdown syntax support
+Content 2, full Markdown syntax support
+Content, full Markdown syntax support
+