LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Co-authored-by: Diana Cheung <18452752+dianacheung@users.noreply.github.com>
This commit is contained in:
dianacheung
2024-04-22 02:02:45 -07:00
committed by GitHub
parent cb5328c309
commit 210f4f1931
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -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