Skip to main content
All CollectionsTips & Tricks
Using Markdown in your styleguide and spacing system descriptions
Using Markdown in your styleguide and spacing system descriptions

Learn about the different Markdown features supported in styleguide and spacing system descriptions

Tuba avatar
Written by Tuba
Updated over 4 months ago

You can add a Markdown-formatted description to your styleguide and spacing system, which allows your team to document the resources available there more formally. Using Markdown, you can organize and stylize the content so it can easily be read and referenced by your team.

In your styleguide and spacing system descriptions, you can mention topics like design philosophy, how the styleguide should be applied across the product, best practices, and so on.

Commonly used Markdown features

Header

Use # in front of some text to provide emphasis. You can even use multiple # to add hierarchy.

 # Baklava       
## Baklava
### Baklava

Bold

You can wrap your text with ** to make it bold.

**Baklava**

Italics

Use _ around your text to make it italics.

_Baklava_

Strike

Add ~ around your text to add a strike through it.

~Baklava~

Code

Add a code block by wrapping the text with `.

`Baklava`

Quote

Using > in front of a block of text will show it indented.

>Baklava

Attachments

You can also add links, images, GIFs, and videos.


Related articles

Did this answer your question?