Instruction file imported from equinor/design-system (
.github/instructions/markdown.instructions.md). Copyright stays with the author.
Markdown Guidelines
- Use
#for top-level headings,##for second-level headings, and so on. - Use hyphen (
-) for lists instead of asterisk. - Use endash (
--) instead of emdash (---). - Use tags for abbreviations, e.g.,
<abbr title="Equinor Design System">EDS</abbr>. - Use Github flavoured markdown
- Use the following highlightning styles for notes, tips, warnings, etc.
List of abbreviations to use
- EDS: Equinor Design System
- APCA: Accessible Perceptual Contrast Algorithm
Examples of highlightning
:::note
Some content with Markdown syntax. Check this api.
:::
:::tip
Some content with Markdown syntax. Check this api.
:::
:::info
Some content with Markdown syntax. Check this api.
:::
:::warning
Some content with Markdown syntax. Check this api.
:::
:::danger
Some content with Markdown syntax. Check this api.
:::