|
| 1 | +--- |
| 2 | +title: teedoc |
| 3 | +category: "websites" |
| 4 | +description: "Static doc site generator from Markdown and jupyter, written with Python." |
| 5 | +icon: teedoc.png |
| 6 | +website: https://teedoc.github.io |
| 7 | +syntax: |
| 8 | + - id: headings |
| 9 | + available: y |
| 10 | + - id: paragraphs |
| 11 | + available: y |
| 12 | + - id: line-breaks |
| 13 | + available: y |
| 14 | + - id: bold |
| 15 | + available: y |
| 16 | + - id: italic |
| 17 | + available: y |
| 18 | + - id: blockquotes |
| 19 | + available: y |
| 20 | + - id: ordered-lists |
| 21 | + available: y |
| 22 | + - id: unordered-lists |
| 23 | + available: y |
| 24 | + - id: code |
| 25 | + available: y |
| 26 | + - id: horizontal-rules |
| 27 | + available: y |
| 28 | + - id: links |
| 29 | + available: y |
| 30 | + - id: images |
| 31 | + available: y |
| 32 | + - id: tables |
| 33 | + available: y |
| 34 | + - id: fenced-code-blocks |
| 35 | + available: y |
| 36 | + - id: syntax-highlighting |
| 37 | + available: y |
| 38 | + - id: footnotes |
| 39 | + available: y |
| 40 | + - id: heading-ids |
| 41 | + available: y |
| 42 | + - id: definition-lists |
| 43 | + available: y |
| 44 | + - id: strikethrough |
| 45 | + available: y |
| 46 | + - id: task-lists |
| 47 | + available: y |
| 48 | + - id: emoji-cp |
| 49 | + available: y |
| 50 | + - id: emoji-sc |
| 51 | + available: n |
| 52 | + - id: highlight |
| 53 | + available: n |
| 54 | + - id: subscript |
| 55 | + available: y |
| 56 | + - id: superscript |
| 57 | + available: y |
| 58 | + - id: auto-url-linking |
| 59 | + available: y |
| 60 | + - id: disabling-auto-url |
| 61 | + available: y |
| 62 | + - id: html |
| 63 | + available: y |
| 64 | +see-also: |
| 65 | + - name: teedoc Markdown Features |
| 66 | + link: https://teedoc.github.io/get_started/en/syntax/syntax_markdown.html |
| 67 | +--- |
| 68 | + |
| 69 | +[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. |
| 70 | + |
| 71 | +teedoc especially suitable for multiple documentation sites or wiki, or knowledge bases. |
| 72 | + |
| 73 | +teedoc uses the [mistune](https://github.com/lepture/mistune) Markdown parser. |
| 74 | + |
| 75 | +{% include image.html file="/assets/images/tools/teedoc.png" alt="Example of teedoc website" %} |
| 76 | + |
| 77 | +{% include tool-syntax-table.html %} |
| 78 | + |
| 79 | +### Support for Additional Syntax Elements |
| 80 | + |
| 81 | +teedoc support many useful additional syntax like: |
| 82 | +* [mermaid](https://mermaid-js.github.io/mermaid/): A simple markdown-like script language for generating charts from text via javascript. |
| 83 | +* math: Support Latex and tex math syntax, and MathML tags. |
| 84 | +* tabset: A easy to use tabset syntax. For example: to show different code examples for different programming languages. |
| 85 | + ```markdown |
| 86 | + .. tabset:: |
| 87 | + :id: tabset1 |
| 88 | + |
| 89 | + ## Kotlin |
| 90 | + |
| 91 | + Content 1, full Markdown syntax support |
| 92 | + |
| 93 | + ## Java |
| 94 | + |
| 95 | + Content 2, full Markdown syntax support |
| 96 | + ``` |
| 97 | + |
| 98 | + will be rendered to: |
| 99 | + ```html |
| 100 | + <div class="tabset tabset-id-tabset1"> |
| 101 | + <div class="tabset-title">Title(optional)</div> |
| 102 | + <div class="tabset-content"> |
| 103 | + <div class="tabset-tab"> |
| 104 | + <span class="tabset-tab-label tabset-tab-active" idx="0">Kotlin</span> |
| 105 | + <span class="tabset-tab-label " idx="1">Java</span> |
| 106 | + </div> |
| 107 | + <div class="tabset-text-container"> |
| 108 | + <div class="tabset-text tabset-text-active" idx="0"> |
| 109 | + <p>Content 1, full Markdown syntax support</p> |
| 110 | + </div> |
| 111 | + <div class="tabset-text" idx="1"> |
| 112 | + <p>Content 2, full Markdown syntax support</p> |
| 113 | + </div> |
| 114 | + </div> |
| 115 | + </div> |
| 116 | + </div> |
| 117 | + ``` |
| 118 | +* details: A syntax to generate HTML5 details tag |
| 119 | + ```markdown |
| 120 | + .. details::Title, click to expand |
| 121 | + |
| 122 | + Content, full Markdown syntax support |
| 123 | + ``` |
| 124 | + |
| 125 | + will be rendered to: |
| 126 | + ```html |
| 127 | + <details> |
| 128 | + <summary>Title, click to expand</summary> |
| 129 | + <div class="details-content"> |
| 130 | + <p>Content, full Markdown syntax support</p> |
| 131 | + </div> |
| 132 | + </details> |
| 133 | + ``` |
| 134 | + |
| 135 | + |
| 136 | +More syntax information visit [teedoc markdown syntax](https://teedoc.github.io/get_started/en/syntax/syntax_markdown.html) |
| 137 | + |
0 commit comments