Skip to content

Features to Articles

This is a test page that contains all possible possible articles features!

Table of contents

Basic Markdown Features

Headings

To create a title, we place "#" before the title. The number of "#" symbols placed will define the type of title (primary, secondary, etc.). Examples:

  • # Heading 1:

Heading 1

  • ## Heading 2:

Heading 2

  • ### Heading 3:

Heading 3

...

  • ###### Heading 6:
Heading 6

Text Formatting

  • Bold:

    **bold text** or __bold text__

    bold text

  • Italic:

    *italic text* or _italic text_

    italic text

  • Strikethrough:

    ~~strikethrough text~~

    strikethrough text

  • Subscript and Superscript:

    Subscript: O~2~ ; Superscript: 1^st^

    Subscript: O2 ; Superscript: 1st

Lists

Ordered list:

1. item 1
2. item 2
  1. item 1
  2. item 2

Unordered list:

- item 1
- item 2
  • item 1
  • item 2

Code

To insert a line of code, we use a backquote (`) at the beginning and end of the line of code. Example:

Input:

`console.log ("Hello, world!");`

Output:

console.log ("Hello, world!");

To insert a code snippet, we use three backquotes at the beginning and end of the block. You can also specify the programming language of your code snippet. Example:

Input:

```js
console.log ("Hello, world!");
```

Output: 

console.log ("Hello, world!");

Table

Input:

| Syntax | Description |
| --- | --- |
| Header | Title |
| Paragraph | Text |

Output:

Syntax Description
Header Title
Paragraph Text

Images:

![Optional image name](../img/logo-omnissa.svg)

Optional image name

Links:

[Omnissa site](https://omnissa.com)

Omnissa site

Notes

Since we are using MkDocs Material, the notes are formatted with "!!! note" instead of the standard markdown formatting "[!NOTE]". Example:

Expanded note:

Note

Test note

Collapsed note (we use "???" instead of "!!!"):

Note

Test note

We can have other types of notes, such as warnings, quotes, infos, etc. Examples:

Warning

test

Danger

test

Quote

test

Info

test

Abstract

test

Tip

test

Success

test

Failure

test

Bug

test

Example

test

Question

test

In any type of note, we can add a custom title or nest one note inside another. Examples:

  • With inner block:

    Info

    Information

    Warning

    warning!

  • With title:

    What was the first programming language to be commercialized?

    FORTRAN

Content Tabs

It's possible to create grouped content within a markdown. Example:

Input: 

=== "Block 1"
    Block 1 content

    - Item 1

    - Item 2

=== "Block 2"
    Block 2 content

    ``` py
        print("Hello, world!")
    ```

Output:

Block 1 content

  • Item 1

  • Item 2

Block 2 content

    print("Hello, world!")

Tooltip

  • Sample tootip:

[Tooltip]("tooltip")

Tooltip

  • Link with tooltip:

[Link with tooltip](https://omnissa.com "tooltip")

Link with tooltip

  • Link with tooltip, reference syntax:
[Link with tooltip, reference syntax][test]
[test]: https://omnissa.com "tooltip"

Link with tooltip, reference syntax

  • Text with abbreviations:
Text with abbreviations ex
*[ex]: Example

Text with abbreviations ex

Footnotes

Lorem ipsum[^1] dolor sit amet, consectetur adipiscing elit.[^2]
[^1]: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
[^2]:
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

Lorem ipsum1 dolor sit amet, consectetur adipiscing elit.2

Partials

Partials

👉 This is an included partial MD.

  1. Lorem ipsum dolor sit amet, consectetur adipiscing elit. ↩

  2. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. ↩