Last updated 2 years ago

GitHub-Flavored Markdown example

Front Matter

---
title: Markdown example
description: GitHub-Flavored Markdown example
---

The title will be automatically used within the sidebar navigation if there is no label defined.

Numbered lists

  1. Wake up
  2. Brush teeth
  3. Exercise

Numbered list with code snippets

  1. Code snippets in a list.
  2. javascriptpythoncpp
    javascript;
    python
    c++
1. Code snippets in a list.
1. ```javascript
   javascript;
   ```

   ```python
   python
   ```

   ```cpp
   c++
   ```

Info blocks

Info blocks:

Warning: I told you so!
Success: Hooyah!
Danger: I really told you so!
Attention: Now that I have your attention...
<div class="warning">Warning: I told you so!</div>

Lists

Sample list:

  • Ctrl+S / Cmd+S to save the file
  • Ctrl+Shift+S / Cmd+Shift+S to choose to save as Markdown or HTML
  • Drag and drop a file into here to load it
  • File contents are saved in the URL so you can share files

Look, another list!

  • API Reference
  • Portal
  • Workflows

Free-form Code samples

And here's some code! 👍

javascriptpythoncpp
javascript;
python
c++
```javascript
javascript;
```

```python
python
```

```c++
c++
```

Credits

This is on GitHub so let me know if I've b0rked it somewhere.

Props to Mr. Doob and his code editor, from which the inspiration to this, and some handy implementation hints, came.

Stuff used to make this: