Skip to content

Commit 56b463b

Browse files
committed
Apply copy edits
1 parent f30e969 commit 56b463b

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

_tools/teedoc.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,7 @@ see-also:
6666
link: https://teedoc.github.io/get_started/en/syntax/syntax_markdown.html
6767
---
6868

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.
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. teedoc is especially suitable for multiple documentation sites, wikis, or knowledge bases.
7270

7371
teedoc uses the [mistune](https://github.com/lepture/mistune) Markdown parser.
7472

@@ -78,10 +76,12 @@ teedoc uses the [mistune](https://github.com/lepture/mistune) Markdown parser.
7876

7977
### Support for Additional Syntax Elements
8078

81-
teedoc support many useful additional syntax like:
79+
teedoc supports many useful additional syntax like:
80+
8281
* [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.
82+
* math: Supports Latex, tex math syntax, and MathML tags.
83+
* tabset: A easy to use tabset syntax. For example, it shows different code examples for different programming languages.
84+
8585
```markdown
8686
.. tabset::
8787
:id: tabset1
@@ -96,6 +96,7 @@ teedoc support many useful additional syntax like:
9696
```
9797

9898
will be rendered to:
99+
99100
```html
100101
<div class="tabset tabset-id-tabset1">
101102
<div class="tabset-title">Title(optional)</div>
@@ -115,14 +116,17 @@ teedoc support many useful additional syntax like:
115116
</div>
116117
</div>
117118
```
118-
* details: A syntax to generate HTML5 details tag
119+
120+
* details: A syntax to generate HTML5 details tag.
121+
119122
```markdown
120123
.. details::Title, click to expand
121124

122125
Content, full Markdown syntax support
123126
```
124127

125128
will be rendered to:
129+
126130
```html
127131
<details>
128132
<summary>Title, click to expand</summary>
@@ -132,6 +136,5 @@ teedoc support many useful additional syntax like:
132136
</details>
133137
```
134138

135-
136-
More syntax information visit [teedoc markdown syntax](https://teedoc.github.io/get_started/en/syntax/syntax_markdown.html)
139+
For more syntax information, visit [teedoc markdown syntax](https://teedoc.github.io/get_started/en/syntax/syntax_markdown.html).
137140

_tools/wikibonsai.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,6 @@ syntax:
7070
available: y
7171
- id: html
7272
available: y
73-
see-also:
74-
- name:
75-
link:
7673
---
7774

7875
[WikiBonsai](https://github.com/wikibonsai/wikibonsai) is a collection of open source tools to bring digital gardening workflows to markdown.

_tools/writerside.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ syntax:
1717
available: y
1818
- id: blockquotes
1919
available: y
20-
notes: "By default, the blockquotes markup will turn into an admonition block called a tip. One can change the block type to note or warning. Read more here: https://www.jetbrains.com/help/writerside/admonition-blocks.html"
20+
notes: "By default, the blockquotes markup will turn into an admonition block called a tip. One can change the block type to note or warning. Read more here: <https://www.jetbrains.com/help/writerside/admonition-blocks.html>."
2121
- id: ordered-lists
2222
available: y
2323
- id: unordered-lists

0 commit comments

Comments
 (0)