Skip to main content

Cheat Sheet

Hotkeys (webstorm)

  • cmd + b - Bold
  • cmd + i - Italic
  • cmd + shift + s - Strikethrough
  • cmd + shift + c - Code

Page description

---
id: doc-markdown
title: Docs Markdown Features
hide_title: false
hide_table_of_contents: false
sidebar_label: Markdown
sidebar_position: 3
pagination_label: Markdown features
description: How do I find you when I cannot solve this problem
slug: /myDoc
---

# Markdown Features

My Document Markdown content

Category description

_category_.yml
label: 'Tutorial'
position: 2 # Position of the category in the sidebar
collapsible: true # Whether the category can be collapsed
collapsed: false # Whether the category is collapsed by default
className: red # Category class name

Information highlighting tools:

Content of the page

import TOCInline from '@theme/TOCInline';

<TOCInline toc={toc} />;

Tabs

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs groupId="operating-systems">
<TabItem value="mac" label="MacOS">
🍎
</TabItem>
<TabItem value="linux" label="Linux">
🐧
</TabItem>
</Tabs>
http://localhost:3000
🍎

Admonitions

:::note Custom title
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`](#).
:::

:::caution
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::

:::danger
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
http://localhost:3000
Custom title

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.

caution

Some content with markdown syntax. Check this api.

danger

Some content with markdown syntax. Check this api.


Import media files

Image

![alt attr value](__assets__/asset.png)

Inline SVG

import DocusaurusSvg from './__assets__/docusaurus.svg'

<DocusaurusSvg />
<DocusaurusSvg className="themedDocusaurus" />

File

[Download this docx using Markdown](../__assets__/example.docx)

Table

| First row | Second row |
|-----------|------------|
| value 1 | value 1 |
| value 2 | value 2 |
| value 3 | value 3 |
http://localhost:3000
First rowSecond row
value 1value 1
value 2value 2
value 3value 3

Collapsible block

<details>
<summary>Title</summary>

Hidden description
</details>
http://localhost:3000
Title
Hidden description

Quote

> This is a quote!
http://localhost:3000

This is a quote!