Skip to content

Commit

Permalink
[Docs] Add section on how to preview docs changes on VSCode (#51019)
Browse files Browse the repository at this point in the history
  • Loading branch information
delbaoliveira committed Jun 9, 2023
1 parent f1f5734 commit 9c44c1d
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions docs/05-community/01-contribution-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,27 @@ If you're new to GitHub, we recommend reading the [GitHub Open Source Guide](htt

The docs are written in [MDX](https://mdxjs.com/), a markdown format that supports JSX syntax. This allows us to embed React components in the docs. See the [GitHub Markdown Guide](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for a quick overview of markdown syntax.

### VSCode Extensions
### VSCode

Although you can use any code editor to write MDX, we recommend the following extensions for VSCode users:
#### Previewing Changes Locally

VSCode has a built-in markdown previewer that you can use to see your edits locally. To enable the previewer for MDX files, you'll need to add a configuration option to your user settings.

Open the command pallete (`⌘ + ⇧ + P` on Mac or `Ctrl + Shift + P` on Windows) and search from `Preferences: Open User Settings (JSON)`.

Then, add the following line to your `settings.json` file:

```json filename="settings.json"
"files.associations": {
"*.mdx": "markdown"
}
```

Next, open the command palette again, and search for `Markdown: Preview File` or `Markdown: Open Preview to the Side`. This will open a preview window where you can see your formatted changes.

#### Extensions

We also recommend the following extensions for VSCode users:

- [MDX](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx): Intellisense and syntax highlighting for MDX.
- [Grammarly](https://marketplace.visualstudio.com/items?itemName=znck.grammarly): Grammar and spell checker.
Expand Down

0 comments on commit 9c44c1d

Please sign in to comment.