Basic Syntax

Overview

Wiki|Docs uses markdown and this document outlines the syntax.

Headings

Markdown Rendered Output
# Heading level 1

Heading level 1

## Heading level 2

Heading level 2

### Heading level 3

Heading level 3

#### Heading level 4

Heading level 4

##### Heading level 5
Heading level 5
###### Heading level 6
Heading level 6

Paragraphs

To create paragraphs, use a blank line to separate one or more lines of text.

Line Breaks

To create a line break or new line (<br>), end a line with two or more spaces, and then type return.

Emphasis

You can add emphasis by making text bold or italic.

Bold

To bold text, add two asterisks or underscores before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters.

Markdown Rendered Output
Example **bold** text. Example bold text.
Example __bold__ text. Example bold text.
Example**bold**text Exampleboldtext

Italic

To italicize text, add one asterisk or underscore before and after a word or phrase. To italicize the middle of a word for emphasis, add one asterisk without spaces around the letters.

Markdown Rendered Output
Example *italicized* text. Example italicized text.
Example _italicized_ text. Example italicized text.
Example*italicized*text Exampleitalicizedtext

Bold and Italic

To emphasize text with bold and italics at the same time, add three asterisks or underscores before and after a word or phrase. To bold and italicize the middle of a word for emphasis, add three asterisks without spaces around the letters.

Markdown Rendered Output
This text is ***really important***. This text is really important.
This text is ___really important___. This text is really important.
This text is __*really important*__. This text is really important.
This text is **_really important_**. This text is really important.
This is really***very***important text. This is reallyveryimportant text.

Blockquotes

To create a blockquote, add a > in front of a paragraph.

> Dorothy followed her through many of the beautiful rooms in her castle.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

Blockquotes with Multiple Paragraphs

Blockquotes can contain multiple paragraphs. Add a > on the blank lines between the paragraphs.

> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Nested Blockquotes

Blockquotes can be nested. Add a >> in front of the paragraph you want to nest.

> Dorothy followed her through many of the beautiful rooms in her castle.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

The rendered output looks like this:

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Blockquotes with Other Elements

Blockquotes can contain other Markdown formatted elements. Not all elements can be used — you’ll need to experiment to see which ones work.

> #### The quarterly results look great!
>
> - Revenue was off the chart.
> - Profits were higher than ever.
>
>  *Everything* is going according to **plan**.

The rendered output looks like this:

The quarterly results look great!

  • Revenue was off the chart.
  • Profits were higher than ever.

Everything is going according to plan.

Extended Syntax

These are extended markdown features in WikiDocs.

Text Highlight

To highlight text, add two equal signs before and after a word or phrase. To highlight the middle of a word for emphasis, add two equal signs without spaces around the letters.

Symbols

WikiDocs can swap symbols at render time. Supported Symbols.

Shortcode Rendered Output
(c) ©
(r) ®
(tm)
(p)
+- ±

Math

WikiDocs can display math typesetting using KaTeX.

Math Inline

Here's a basic math inline.

Math inline: $u = 10\\frac{m}{s}$ and $a = 2\\frac{m}{s^{2}}$ at $t = 1s$

The rendered output looks like this:

Math inline: $u = 10\frac{m}{s}$ and $a = 2\frac{m}{s^{2}}$ at $t = 1s$

Math Block

Here's a basic math block.

$$
f(x) = \int_{-\infty}^\infty
    \hat f(\xi)\,e^{2 \pi i \xi x}
    \,d\xi
$$

The rendered output looks like this: $$ f(x) = \int_{-\infty}^\infty \hat f(\xi)\,e^{2 \pi i \xi x} \,d\xi $$

Charts and Diagrams

WikiDocs can display different kinds of charts and diagrams using mermaid.js.org.

Basic ER database.

erDiagram
    PRODUCT ||--o{ SALES_FACT_1998 : "has"
    TIME_BY_DAY ||--o{ SALES_FACT_1998 : "has"
    CUSTOMER ||--o{ SALES_FACT_1998 : "has"
    PROMOTION ||--o{ SALES_FACT_1998 : "has"
    STORE ||--o{ SALES_FACT_1998 : "has"

    PRODUCT {
        string product_id PK
        string product_class_id FK
        string brand_name
        string SKU
        string product_name
    }

    SALES_FACT_1998 {
        string product_id FK
        string time_id FK
        string customer_id FK
        string promotion_id FK
        string store_id FK
        decimal store_sales
        decimal store_cost
        decimal unit_sales
    }

    TIME_BY_DAY {
        string time_id PK
        date the_date
        string the_month
        string the_day
        integer the_year
    }

    CUSTOMER {
        string customer_id PK
        string account_num
        string lname
        string fname
        string address
    }

    PROMOTION {
        string promotion_id PK
        string promotion_name
        date start_date
        date end_date
    }

    STORE {
        string store_id PK
        string store_type
        string region_id FK
        string store_name
    }

Which will render this.

erDiagram PRODUCT ||--o{ SALES_FACT_1998 : "has" TIME_BY_DAY ||--o{ SALES_FACT_1998 : "has" CUSTOMER ||--o{ SALES_FACT_1998 : "has" PROMOTION ||--o{ SALES_FACT_1998 : "has" STORE ||--o{ SALES_FACT_1998 : "has" PRODUCT { string product_id PK string product_class_id FK string brand_name string SKU string product_name } SALES_FACT_1998 { string product_id FK string time_id FK string customer_id FK string promotion_id FK string store_id FK decimal store_sales decimal store_cost decimal unit_sales } TIME_BY_DAY { string time_id PK date the_date string the_month string the_day integer the_year } CUSTOMER { string customer_id PK string account_num string lname string fname string address } PROMOTION { string promotion_id PK string promotion_name date start_date date end_date } STORE { string store_id PK string store_type string region_id FK string store_name }

Here's a basic mindmap.

```mermaid
mindmap
  root((mindmap))
    Origins
      Long history
      Popularisation
    Research
      On effectiveness<br/>and features
      On Automatic creation
    Tools
      Pen and paper
      Mermaid
```

The rendered output looks like this.

mindmap root((mindmap)) Origins Long history Popularisation Research On effectiveness<br/>and features On Automatic creation Tools Pen and paper Mermaid

Even more

WikiDocs utilizes ParsedownPlus to introduce custom tags, enhancing the standard Markdown functionality for improved document authoring.

Youtube embedding

[video src="https://www.youtube.com/watch?v=Ta_wxUvvO4c"]

Vimeo embedding

[video src="https://vimeo.com/423640994"]

Colored text

Custom colors [color=#ff0000]Red[/color], [color=#00FF00]Green[/color], [color=#0000FF]Blue[/color].

Custom colors Red, Green, Blue.

Predefined colors

Colors can be defined in ParsedownPlus/config.php.

Forced RTL/LTR

[rtl]Forced RTL example.[/rtl]

Forced RTL example.

Forced monospace font

[mono]Forced monospace example.[/mono]

Forced monospace example.

Collapsible section

+++ Collapsible title (optional)
This is the content for the collapsible section. If title is not defined, it will default to: `Click to expand`
+++

Collapsible title (optional)

This is the content for the collapsible section. If title is not defined, it will default to: Click to expand

This page was last edited on 2024-07-01 08:15

Powered by Wiki|Docs

This page was last edited on 2024-07-01 08:15

Manuel Zavatta | WikiDocs.it
Copyright © All rights reserved

Powered by Wiki|Docs