Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: mention admonition quirks with Prettier #6135

Merged
merged 4 commits into from
Dec 20, 2021
Merged

docs: mention admonition quirks with Prettier #6135

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2689749
docs: mention admonition quirks with Prettier
yangshun Dec 20, 2021
95b5186
Update markdown-features-admonitions.mdx
yangshun Dec 20, 2021
9c16869
Update markdown-features-admonitions.mdx
yangshun Dec 20, 2021
21aa712
Update markdown-features-admonitions.mdx
yangshun Dec 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions website/docs/guides/markdown-features/markdown-features-admonitions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,28 @@ Some **content** with _markdown_ `syntax`. Check [this `api`](#).

:::

## Usage with Prettier {#usage-with-prettier}

If you use [Prettier](https://prettier.io) to format your Markdown files, Prettier might autoformat your code to invalid admonition syntax. To avoid this problem, add empty lines around the starting and ending directives. This is also why the examples we show here all have empty lines around the content.

<!-- prettier-ignore -->
```md
<!-- Prettier doesn't change this -->
::: note

Hello world

:::

<!-- Prettier changes this -->
::: note
Hello world
:::

<!-- to this -->
::: note Hello world:::
```

## Specifying title {#specifying-title}

You may also specify an optional title
Expand Down