Skip to content

Commit

Permalink
fix: heading hierarchy
Browse files Browse the repository at this point in the history
  • Loading branch information
abernier committed Sep 14, 2024
1 parent 25d5bb0 commit 930c6e8
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/getting-started/authoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ sourcecode: to/my-document.mdx
MARKDOWN
```

### Frontmatter
## Frontmatter

Any key is optional.

Expand All @@ -31,13 +31,13 @@ Any key is optional.
- will be used as metadata image if provided
- `nav`: order in the navigation (on the same level)

### MARKDOWN
## MARKDOWN

You can use any [GitHub Flavored Markdown](https://github.github.com/gfm/) syntax.

Plus, all exported [`components/mdx/index.tsx`](components/mdx/index.tsx) MDX components.

#### `Img`
### `Img`

Relative images are supported. Eg, inside your [`MDX`](introduction#configuration:~:text=MDX) folder:
```text {2}
Expand Down Expand Up @@ -95,7 +95,7 @@ Although it is probably better to use CSS for this:
> [!NOTE]
> See [`MDX_BASEURL`](introduction#configuration:~:text=MDX_BASEURL) to understand how it is converted to a full URL.
#### Code
### Code

Line numbers/highlights are supported:

Expand Down Expand Up @@ -192,7 +192,7 @@ index 8c3317a..47ea956 100644

</details>

#### `Grid`
### `Grid`

Responsive grid.

Expand Down Expand Up @@ -220,7 +220,7 @@ Responsive grid.

</details>

#### `Sandpack`
### `Sandpack`

Inline sandboxes.

Expand Down Expand Up @@ -293,7 +293,7 @@ export default function App() {



#### `Codesandbox`
### `Codesandbox`

```md
<Codesandbox id="3rjsl" />
Expand All @@ -306,7 +306,7 @@ export default function App() {

</details>

#### `Gha`
### `Gha`

Aka. ["GitHub alerts"](https://github.com/orgs/community/discussions/16925)

Expand Down Expand Up @@ -346,7 +346,7 @@ or better:
</details>

#### `Hint`
### `Hint`

> [!CAUTION]
> Deprecated, use [`Gha[keyword="NOTE"]`](#Gha) instead.
Expand Down

0 comments on commit 930c6e8

Please sign in to comment.