Skip to content

Commit 3bae66f

Browse files
committed
fix: doc
1 parent 332c7fb commit 3bae66f

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/getting-started/authoring.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ Plus, all exported [`components/mdx/index.tsx`](components/mdx/index.tsx) MDX co
4848

4949
### `Intro`
5050

51+
Use at the top of the document, just after the frontmatter.
52+
5153
```md
5254
<Intro>
5355
This is an intro. Here you can write a long description of the article, longer than the frontmatter `description`, eventually with [links](#), lists, etc.
@@ -68,8 +70,10 @@ Plus, all exported [`components/mdx/index.tsx`](components/mdx/index.tsx) MDX co
6870

6971
### `Keypoints`
7072

73+
Can be used after `Intro`, to list main points the article covers: one bullet per `KeypointsItem`.
74+
7175
```md
72-
<Keypoints>
76+
<Keypoints title="What you'll learn">
7377
<KeypointsItem>First item</KeypointsItem>
7478
<KeypointsItem>Second **item**</KeypointsItem>
7579
</Keypoints>
@@ -78,7 +82,7 @@ Plus, all exported [`components/mdx/index.tsx`](components/mdx/index.tsx) MDX co
7882
<details>
7983
<summary>Result</summary>
8084

81-
<Keypoints>
85+
<Keypoints title="What you'll learn">
8286
<KeypointsItem>First item</KeypointsItem>
8387
<KeypointsItem>Second **item**</KeypointsItem>
8488
</Keypoints>

0 commit comments

Comments
 (0)