Commit 12b38c
2026-03-21 18:44:08 joris: eerste opzet| /dev/null .. markdown.md | |
| @@ 0,0 1,189 @@ | |
| + | # Markdown |
| + | |
| + | Markdown Syntax |
| + | Emphasis |
| + | **bold** |
| + | *italics* |
| + | ~~strikethrough~~ |
| + | ==mark== |
| + | bold |
| + | italics |
| + | strikethrough |
| + | mark |
| + | You can use backslash escapes to generate literal characters that are used for formatting otherwise, e.g. |
| + | \*literal asterisks\* |
| + | *literal asterisks* |
| + | Headings |
| + | # h1 - Large header |
| + | h1 - Large Header |
| + | ## h2 - Medium header |
| + | h2 - Medium Header |
| + | ### h3 - Small header |
| + | h3 - Small Header |
| + | #### h4 - Tiny header |
| + | h4 - Tiny Header |
| + | Lists |
| + | - Generic list items |
| + | - in an unordered list |
| + | Generic list items |
| + | in a unordered list |
| + | |
| + | 1. List items |
| + | 2. in an ordered list |
| + | 3. numbered with numbers |
| + | List items |
| + | in an ordered list |
| + | numbered with numbers |
| + | |
| + | 1. Numbered list with |
| + | - a nested |
| + | - unordered list |
| + | 2. inside |
| + | Numbered list with |
| + | a nested |
| + | unordered list |
| + | inside |
| + | Note: To create nested sublists, they must be indented the same number of spaces that a paragraph would need to be in order to be included in the list item. In other words, sublist markers must match the indentation of the content of the outer list items. |
| + | |
| + | Links |
| + | [[WikiPage]] |
| + | WikiPage |
| + | [[Text to display|WikiPage]] |
| + | Text to display |
| + | http://www.example.com |
| + | http://example.com |
| + | [Link with text](http://example.com) |
| + | Link with text |
| + | Quotes |
| + | > This is a quote. |
| + | > It can span multiple lines! |
| + | >> And multiple levels. |
| + | >> *With markdown syntax.* |
| + | This is a quote. It can span multiple lines! |
| + | |
| + | And multiple levels. |
| + | With markdown syntax. |
| + | |
| + | Images |
| + | You can copy n paste images directly into the editor, they will be uploaded as attachments. |
| + | |
| + |  |
| + | Check the attachments of a page, there are links for copy'n'paste. |
| + | |
| + | Tables |
| + | | Column 1 | Column 2 | Column 3 | |
| + | | -------- | -------- | -------- | |
| + | | John | Doe | Peach | |
| + | | Mary | Smith | Banana | |
| + | Column 1 Column 2 Column 3 |
| + | John Doe Peach |
| + | Mary Smith Banana |
| + | Code |
| + | Inline code `int n = 1` with backticks. |
| + | Inline code int n = 1 with backticks. |
| + | ``` |
| + | Code Blocks |
| + | ``` |
| + | Code Blocks |
| + | To add syntax highlighting, specify a language next to the backticks before the fenced code block. |
| + | ```python |
| + | #!/usr/bin/env python |
| + | assert 1 + 1 == 2 |
| + | print("Hello World!") |
| + | ``` |
| + | #!/usr/bin/env python |
| + | assert 1 + 1 == 2 |
| + | print("Hello World!") |
| + | To enable line numbers in the code block, append an equal sign |
| + | = |
| + | to the language. |
| + | ```python= |
| + | print("Hello Line Numbers!") |
| + | ``` |
| + | 1 |
| + | print("Hello Line Numbers!") |
| + | Mathjax |
| + | Inline math: `$a^2+b^2=c^2$` |
| + | Inline Math: |
| + | Math block: |
| + | ```math |
| + | a^2+b^2=c^2 |
| + | ``` |
| + | Math block: |
| + | like syntax: |
| + | Inline Math: $a^2+b^2=c^2$ |
| + | Inline Math: |
| + | Equation: |
| + | $$a^2+b^2=c^2$$ |
| + | Footnotes |
| + | Footnote identifiers[^1] are single characters |
| + | or words[^bignote]. And can be referenced |
| + | multiple[^1] times. |
| + | |
| + | [^1]: Footnotes can be a single line. |
| + | |
| + | [^bignote]: Or more complex. |
| + | |
| + | Indent paragraphs to include them |
| + | in the footnote. |
| + | |
| + | Add as many paragraphs as you like. |
| + | Footnote identifiers1 are single characters or words2. And can be referenced multiple1 times. |
| + | a, b Footnotes can be a single line. |
| + | Or more complex. |
| + | Indent paragraphs to include them in the footnote. |
| + | |
| + | Add as many paragraphs as you like. |
| + | |
| + | GNU Terry Pratchett. |
| + | Abbreviations |
| + | Defining abbreviations allows tooltips to display when hovering on those abbreviations |
| + | The HTML specification is maintained by the W3C. |
| + | *[HTML]: Hyper Text Markup Language |
| + | *[W3C]: World Wide Web Consortium |
| + | The HTML specification is maintained by the W3C. |
| + | |
| + | Blocks |
| + | These special blocks are not part of the markdown standard, but are helpful for structuring content. |
| + | Fancy blocks |
| + | ::: info |
| + | # Head of the block. |
| + | With _formatted_ content. |
| + | ::: |
| + | Head of the block |
| + | With formatted content. |
| + | Block styles available: info, success, warning, danger and none. |
| + | Spoiler blocks |
| + | >! Spoiler blocks reveal their |
| + | >! content on click on the icon. |
| + | |
| + | Folded blocks |
| + | >| # Headline is used as summary |
| + | >| with the details folded. |
| + | Headline is used as summary |
| + | Alerts |
| + | > [!NOTE] |
| + | > Useful for highlighting special |
| + | > information. |
| + | Note |
| + | Useful for highlighting special information. |
| + | |
| + | Alerts available: [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] and [!CAUTION]. |
| + | Diagrams |
| + | Using Mermaid you can create diagrams and visualizations in your wiki pages. |
| + | ```mermaid |
| + | flowchart LR |
| + | A[An Otter Wiki]-- supports ---Mermaid |
| + | ``` |
| + | |
| + | Mermaid support all kinds of diagrams: flowcharts, class diagrams, pie charts, mindmaps, etc. For more information see the Mermaid Documentation. |
| + | Embeddings |
| + | An Otter Wiki supports Embeddings which are beyond the official Markdown syntax. |
| + | {{AttachmentList}}: Render the attachments to the current page as table. |
| + | {{DataTable}}: Renders sort-, search and pageable tables. |
| + | {{ImageFrame}}: Render an image/images in a framed box next to the main content. |
| + | {{InfoBox}}: Render structured information next to the main content in a standardized way |
| + | {{Video}}: Embed a video from an url or an attachment |
| + | See the Syntax/Embedding Guide for details. |
| + | Remark |
| + | There's actually a lot more to Markdown than this. See the official introduction and syntax for more information. Please Note: An Otter Wiki is not using the official implementation. This might lead to small differences in the little things. |