Docs Cheatsheet
On this page you'll find every single markdown & mdx component used in our docs
#
Page Title & DataFor the title of the page, and the name of the tab, at the very top of your file, just add this code snippet to the top.
Any thing inbetween the ---
tags will be used for the meta data of the page
---title: Cheatsheetid: page-id-when-linking-to-it---
For Heading 1 specifically, you should set the page title in the meta data.
# Heading 1
#
Heading 2## Heading 2
#
Heading 3### Heading 3
#
Heading 4#### Heading 4
#
Heading 5##### Heading 5
#
Heading 6###### Heading 6
#
Line breaksSome text
With a line between them
#
Lists#
Unordered lists- Unordered list 1
- Unordered list 2
- Unordered list 3
- Unordered list 1- Unordered list 2- Unordered list 3
#
Unordered listsYou don't actually have to do the numbers, as long as there is a number at the start it'll count incrementally starting with the first number in the list
- Ordererd list 1
- Ordererd list 2
- Ordererd list 3
1. Ordererd list 169. Ordererd list 242. Ordererd list 3
#
Nested & Mixed lists- Ordererd list
- Sable
- Ferret
- Cat rat
- Fox weasel
- Lamp
- Ordererd list
- Grape
- Potatoes
- Chips
- Crisps
- Fondant
- Frites
- Chips
- Lemons
- Three cats
- Pasta
- Ragu
- Ordererd list
1. Ordererd list 1. Sable 2. Ferret - Cat rat - Fox weasel 8. Lamp69. Ordererd list - Grape - Potatoes - Chips 1. Crisps 1. Fondant 1. Frites - Lemons 1. Three cats 1. Pasta 9. Ragu42. Ordererd list
#
Text stylingItalic/Emphasize
_Italic/Emphasize_
Strong/Bold
**Strong/Bold**
Italic & Bold
**_Italic & Bold_**
#
CodeblocksSo you basically define a section using the ```
anything between two lines that contain these 3 back quotes will be in the block
If you want specific formatting for a certain language like for example Javascript here:
const threeCats = ["cat", "cat", "cat"]
Mind the indentation here, code blocks in code blocks isn't normal usage ```js const threeCats = ["cat", "cat", "cat"] ```
Theres a lot of different formattings to use, md
, js
, ts
, etc. The package used is Prism react render
#
QuotesQuoted text.
Quoted quote.
Quoted text.
Quoted quote.
Quoted quote.
Quoted text.
Quoted quote.
Quoted quote.
Quoted quote.
> Quoted text.
> > Quoted quote.
> Quoted text.> > Quoted quote.> > > Quoted quote.
> Quoted text.> > Quoted quote.> > > Quoted quote.> > > > Quoted quote.
#
AdmonitionsThese are nifty notification blocks from Docusaurus
note
The content and title can include markdown.
Your Title
The content and title can include markdown.
You can specify an optional title
Heads up! Here's a pro-tip.
info
Useful information.
caution
Warning! You better pay attention!
danger
Danger danger, mayday!
:::note
The content and title *can* include markdown.
:::
:::note Your Title
The content and title *can* include markdown.
:::
:::tip You can specify an optional title
Heads up! Here's a pro-tip.
:::
:::info
Useful information.
:::
:::caution
Warning! You better pay attention!
:::
:::danger
Danger danger, mayday!
:::
#
LinksThe links in this paragraph are being pulled from a list a link and another link.
The links in this paragraph are being pulled from a list [a link][1] andanother [link][2].
This is that list
[1]: http://example.com/ "Title"[2]: http://example.org/ "Title"
#
Images#
Alt tags for imagesYou can update the alt tag data for text like this:
Logo:
Logo: 
You can create a image with a hyperlink to another page or a hash link on the page by adding the link in the brackets next to it
Linked logo: [](https://docs.flashbots.net/ "Off to the docs")
#
MDX featuresA quick note on using what's called .mdx
features, mdx
means markdown extended, to used these features, you need to name your file to have the extention .mdx
For example cheatsheet.mdx
This lets you use react components that are a bit more intricate that the standard markdown features.
To make use of an mdx
component like Tabs
, you need to add any import ... from ...
lines to the top of the page, but below the meta data section. Heres an example:
---title: Cheatsheet (Heading 1)---import Tabs from '@theme/Tabs';import TabItem from '@theme/TabItem';
#
TabsThis is an example of the tabs
component.
For extend usage, please refer to the Docusaurus documentation.
- Apple
- Orange
- Banana
import Tabs from '@theme/Tabs';import TabItem from '@theme/TabItem';
<Tabs defaultValue="apple" values={[ {label: 'Apple', value: 'apple'}, {label: 'Orange', value: 'orange'}, {label: 'Banana', value: 'banana'}, ]}> <TabItem value="apple">This is an apple ๐</TabItem> <TabItem value="orange">This is an orange ๐</TabItem> <TabItem value="banana">This is a banana ๐</TabItem></Tabs>
#
Inline Table of ContentsIf you need a table contents literally anywhere, you can make use of the <TOCInline>
component.
For extend usage, please refer to the Docusaurus documentation.
import TOCInline from '@theme/TOCInline'
<TOCInline toc={toc} />
#
Footnotes & referencesThis is how we make a reference to a foot note or reference that's found at the bottoms of the page.1
This is how we make a reference to a footnote [^1] that's found at the bottoms of the page
To create list of foot notes, you just add list like this somewhere, preferably at the bottom of the file
[^1]: an amazing foot note, you can add links n things here as usual
- an amazing foot note, you can add links n things here as usualโฉ