Skip to content

Commit

Permalink
update the documentation for the steps component (#3356)
Browse files Browse the repository at this point in the history
* update the documentation for the steps component

* format with prettier
  • Loading branch information
87xie authored Oct 3, 2024
1 parent 7b919a2 commit 1ebc622
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 21 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ CSS into a specified cascade layer:

<Steps>

### Install `postcss-import`
## Install `postcss-import`

Install `postcss-import` and add it to `postcss.config.js`:

Expand All @@ -23,7 +23,7 @@ module.exports = {
}
```

### Disable Automatic Import of the Nextra Official Theme CSS
## Disable Automatic Import of the Nextra Official Theme CSS

Nextra by default automatically imports the official theme CSS. You can disable
this behavior by setting `autoImportThemeStyle: false` in the Nextra
Expand All @@ -37,7 +37,7 @@ const withNextra = nextra({
})
```

### Set Up the Cascade Layers
## Set Up the Cascade Layers

In your CSS file (e.g. `styles.css`), import the `nextra-docs-theme` CSS and
specify the layers:
Expand All @@ -52,7 +52,7 @@ specify the layers:
}
```

### Import Your CSS File
## Import Your CSS File

Create a `pages/_app.jsx` file and import your CSS files there:

Expand Down
27 changes: 10 additions & 17 deletions docs/pages/docs/guide/built-ins/steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,18 @@ This is the third step description.

## Usage

Wrap a set of markdown h3 headings with the `Steps` component to turn them into
visual steps.

<Steps>

### Step 1

Content for step 1.

### Step 2

Contents for step 2.

</Steps>
Wrap a set of markdown headings with the `<Steps>` component to turn them into
visual steps. It supports `<h2>`, `<h3>`, and `<h4>` headings. You can choose
the appropriate heading level based on the content hierarchy on the page.

{/* prettier-ignore */}
```mdx
```mdx filename="MDX" {7-15}
import { Steps } from 'nextra/components'

## Getting Started

Here is some description.

<Steps>
### Step 1

Expand All @@ -55,14 +48,14 @@ Contents for step 2.
</Steps>
```

### Excluding Headings from Table of Contents
## Excluding Headings from Table of Contents

To exclude the headings from the `<Steps>` component (or any other headings) to
appear in the Table of Contents, replace the Markdown headings `### ...` with
`<h3>` HTML element wrapped in curly braces.

{/* prettier-ignore */}
```diff
```diff filename="MDX"
<Steps>
- ### Step 1
+ {<h3>Step 1</h3>}
Expand Down

0 comments on commit 1ebc622

Please sign in to comment.