Skip to content

Commit

Permalink
fix: doc
Browse files Browse the repository at this point in the history
  • Loading branch information
abernier committed Sep 14, 2024
1 parent 332c7fb commit 3bae66f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/getting-started/authoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ Plus, all exported [`components/mdx/index.tsx`](components/mdx/index.tsx) MDX co

### `Intro`

Use at the top of the document, just after the frontmatter.

```md
<Intro>
This is an intro. Here you can write a long description of the article, longer than the frontmatter `description`, eventually with [links](#), lists, etc.
Expand All @@ -68,8 +70,10 @@ Plus, all exported [`components/mdx/index.tsx`](components/mdx/index.tsx) MDX co

### `Keypoints`

Can be used after `Intro`, to list main points the article covers: one bullet per `KeypointsItem`.

```md
<Keypoints>
<Keypoints title="What you'll learn">
<KeypointsItem>First item</KeypointsItem>
<KeypointsItem>Second **item**</KeypointsItem>
</Keypoints>
Expand All @@ -78,7 +82,7 @@ Plus, all exported [`components/mdx/index.tsx`](components/mdx/index.tsx) MDX co
<details>
<summary>Result</summary>

<Keypoints>
<Keypoints title="What you'll learn">
<KeypointsItem>First item</KeypointsItem>
<KeypointsItem>Second **item**</KeypointsItem>
</Keypoints>
Expand Down

0 comments on commit 3bae66f

Please sign in to comment.