Skip to content

Commit 6535676

Browse files
committed
Minor improvements
1 parent 16108ed commit 6535676

File tree

1 file changed

+6
-10
lines changed
  • src/content/docs/style-guide/components

1 file changed

+6
-10
lines changed

src/content/docs/style-guide/components/index.mdx

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,15 @@ sidebar:
55
---
66
import { Details } from "~/components";
77

8-
Our content is written in [MDX](https://docs.astro.build/en/guides/markdown-content/), an extended version of plain Markdown that lets you use JavaScript expressions and components in your Markdown content. You can use our custom components to add additional formatting to the Cloudflare Docs, such as buttons, tabs, and collapsible sections.
8+
When you are [contributing to the Cloudflare Docs](/style-guide/contributions/), you can use our custom components to add additional formatting, such as buttons, tabs, and collapsible sections.
99

10-
This page shows you the basics of importing and adding a component to a page. Refer to each component page in this Style Guide to learn the specific props and requirements for each.
10+
This guide shows you the basics of importing and adding a component to a page. Refer to each component page in this Style Guide to learn the specific props and requirements for each.
1111

12-
Our components are based on [Astro components](https://docs.astro.build/en/basics/astro-components/).
13-
14-
[Learn more about the Cloudflare Docs framework.](/style-guide/how-we-docs/our-site/#site-framework)
12+
Our components are based on [Astro components](https://docs.astro.build/en/basics/astro-components/) and are written in [MDX](https://docs.astro.build/en/guides/markdown-content/), an extended version of Markdown. [Learn more about the Cloudflare Docs framework](/style-guide/how-we-docs/our-site/#site-framework).
1513

1614
## Add a component to a page
1715

18-
To add a component to a page, you need to import it to the page and then add it:
16+
To add a component to a page:
1917

2018
1. Import the component to the page by adding this text directly below the [frontmatter](/style-guide/frontmatter/):
2119

@@ -37,7 +35,7 @@ To add a component to a page, you need to import it to the page and then add it:
3735
import { DashButton } from "~/components";
3836
```
3937

40-
2. Add the component to the page by adding this text wherever on the page you want the component to appear:
38+
2. Add the component to the page by adding this text anywhere on the page you want the component to appear:
4139

4240
```mdx
4341
<COMPONENT_NAME PROP_NAME="PROP_VALUE" />
@@ -55,6 +53,4 @@ To add a component to a page, you need to import it to the page and then add it:
5553
```
5654
<Details header="This is how this example would display after it is published:">
5755
![DashButton component example](~/assets/images/style-guide/ui-elements/dashbutton-example.png)
58-
</Details>
59-
60-
Each component has its own specific props and requirements, explained in each component page in this Style Guide.
56+
</Details>

0 commit comments

Comments
 (0)