Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: correct contribute documentation preview locally (#1532) #1533

Merged
merged 1 commit into from
Apr 22, 2024
Merged

fix: correct contribute documentation preview locally (#1532) #1533

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,18 @@ Don't forget to revert the changes to **package.json** files later.

Additions and updates to our documentation are very welcome. You can find the documentation in the `docs/` folder, and this is published to https://redocly.com/docs/cli/ as part of our main website.

To preview your changes locally, run this command from the `docs/` folder:
To preview your documentation changes locally:

1. Make sure `redocly` is already installed on your local computer. See [installation](https://redocly.com/docs/cli/installation/).

2. Run this command from the `docs/` folder:

```bash
https://redocly.com/docs/cli/
redocly preview
```

By default, you can access the docs preview at http://localhost:4000 or http://127.0.0.1:4000.

> Please note that currently the custom markdoc tags used in the main website are not available in the local preview version, and links that point to the wider website do show as errors when using a local platform. The pull request workflows generate a full preview, so rest assured that you are able to check everything is in good shape before we review and merge your changes.

### Prose linting
Expand Down
Loading