Skip to main content

Markdown Cheat Sheet

See this file in GitHub
https://github.com/aquivalabs/AqLib/blob/main/website/docs/markdown-cheatsheet.md

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax.

Additionally, it includes several docusaurus specific features

These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.

Heading​

H1

H2​

H3​

Bold​

bold text

Italic​

italicized text

Blockquote​

blockquote

Ordered List​

  1. First item
  2. Second item
  3. Third item

Unordered List​

  • First item
  • Second item
  • Third item
# H1
## H2
### H3
**bold text**
*italicized text*
> blockquote

1. First item
2. Second item
3. Third item

- First item
- Second item
- Third item

Inline Code​

code

Code Blocks​

```apex | js | html title="/lwc/helloApp.js"
/lwc/helloApp.js
import { track, wire, LightningElement } from 'lwc';
export default class HelloApp extends LightningElement {

greeting = 'Hello!';
connectedCallback() {
console.log(this.say); // Hello!
}
}
example.apex
public inherited sharing class HelloApp {
String greeting = 'Hello!';

public HelloApp() {
System.debug(greeting); // Hello!
}
}

For SOQL queries use apex highlight

SELECT Id, Name FROM Account WHERE website = 'https://aquivalabs.com'

Horizontal Rule​


Markdown Guide

Image​

alt text

---
[Markdown Guide](https://www.markdownguide.org)
![alt text](https://www.markdownguide.org/assets/images/tux.png)

Table​

SyntaxDescription
HeaderTitle
ParagraphText
| Syntax | Description |
|-----------|-------------|
| Header | Title |
| Paragraph | Text |

Footnote​

Here's a sentence with a footnote. 1

Heading ID​

My Great Heading​

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote.

### Heading ID
resolved to #heading-id
### My Great Heading \{#custom-id}
resolved to #custom-id

Strikethrough​

The world is flat.

Task List​

  • Write the press release
  • Update the website
  • Contact the media

Emoji​

That is so funny! 😂

(See also Copying and Pasting Emoji)

~~Strikethrough~~
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

That is so funny! :joy:

Admonitions​

info

Some content with Markdown syntax. Check this api.

Diagrams​

Mermaid​

See the Mermaid config documentation and the Mermaid config types for the available config options.

PlantUML​

TBD

Front Matter​

Markdown documents have metadata at the top called Front Matter:

For documentation

---
sidebar_position: 1
link_to_source: 'AqLib/apex/csv-reader'
---

## Markdown heading

Markdown text with [links](./hello.md)

Footnotes​

  1. This is the footnote. ↩