Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add tool teedoc #129

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 137 additions & 0 deletions _tools/teedoc.md
Original file line number Diff line number Diff line change
@@ -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
<div class="tabset tabset-id-tabset1">
<div class="tabset-title">Title(optional)</div>
<div class="tabset-content">
<div class="tabset-tab">
<span class="tabset-tab-label tabset-tab-active" idx="0">Kotlin</span>
<span class="tabset-tab-label " idx="1">Java</span>
</div>
<div class="tabset-text-container">
<div class="tabset-text tabset-text-active" idx="0">
<p>Content 1, full Markdown syntax support</p>
</div>
<div class="tabset-text" idx="1">
<p>Content 2, full Markdown syntax support</p>
</div>
</div>
</div>
</div>
```
* details: A syntax to generate HTML5 details tag
```markdown
.. details::Title, click to expand

Content, full Markdown syntax support
```

will be rendered to:
```html
<details>
<summary>Title, click to expand</summary>
<div class="details-content">
<p>Content, full Markdown syntax support</p>
</div>
</details>
```


More syntax information visit [teedoc markdown syntax](https://teedoc.github.io/get_started/en/syntax/syntax_markdown.html)

Binary file added assets/images/tool-icons/teedoc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/tools/teedoc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.