new(guide): Add mkdocs install & preview instructions to CONTRIBUTING.md (#1494)

pull/1507/head
Robert Dailey 9 months ago committed by GitHub
parent 9144f74c85
commit e2a460bffc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -14,9 +14,9 @@
<!-- ## Learning
If you're adding a new Custom Format, make sure you follow the [Radarr/Sonarr Custom Format (JSON) Guidelines](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CONTRIBUTING.md). -->
If you're adding a new Custom Format, make sure you follow the [Radarr/Sonarr Custom Format (JSON) Guidelines](https://github.com/TRaSH-Guides/Guides/blob/master/CONTRIBUTING.md). -->
## Requirements
- [ ] These changes meet the standards for [contributing](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CONTRIBUTING.md).
- [ ] These changes meet the standards for [contributing](https://github.com/TRaSH-Guides/Guides/blob/master/CONTRIBUTING.md).
- [ ] I have read the [code of conduct](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CODE_OF_CONDUCT.md).

@ -144,4 +144,40 @@ When updating or adding a new CF the test case url (`trash_regex`) needs to be p
## Recommendations
- use [VSCode](https://code.visualstudio.com/) for editing with the following extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
Use [VSCode](https://code.visualstudio.com/) for editing. VS Code should recommend extensions to you
based on the `.vscode/extensions.json` file; you should install all of them.
## Preview Docs Locally
### Prerequisites
These prerequisites are taken from the [mkdocs installation instructions][mkdocinstall].
- Install a recent version of [Python 3](https://www.python.org/).
- `pip` is also required, but should come with Python. Run `pip --version` to check if its available
and working. See the [installation instructions](https://pip.pypa.io/en/stable/installation/).
[mkdocinstall]: https://www.mkdocs.org/user-guide/installation/
### Mkdocs Installation
First, install mkdocs:
```bash
pip install mkdocs
```
Then, install dependent modules using the command below. This command should be run in the root
directory of the repository (i.e. where the `requirements.txt` file is). If the `pip` command does
not work, refer to the mkdocs installation page linked in the Prerequisite section above.
```bash
pip install -r docs/requirements.txt
```
Once everything is installed, run the command below to start a local dev server to preview your
changes to mkdocs:
```bash
mkdocs serve
```

@ -3,7 +3,7 @@
!!! note ""
Here you will find a collection of Scripts you can use with Bazarr.
Most of them are provided by other users, if you got a script you want to share don't hesitate to create a [PR](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CONTRIBUTING.md) for it
Most of them are provided by other users, if you got a script you want to share don't hesitate to create a [PR](https://github.com/TRaSH-Guides/Guides/blob/master/CONTRIBUTING.md) for it
## 2 to 3 language code

Loading…
Cancel
Save