-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
# Contribute to this documentation | ||
|
||
If you find an issue with this documentation please file an issue or submit a pull request on the [linc-convert repository](https://github.com/lincbrain/linc-convert). | ||
If you find an issue with this documentation please file an issue or submit a pull request on the [linc-convert](https://github.com/lincbrain/linc-convert) repository. | ||
|
||
If you would like to contribute to the LINC documentation and render the documentation locally as you make edits, please follow the steps below: | ||
|
||
1. Fork the [linc-convert repository](https://github.com/lincbrain/linc-convert) and clone it to your computer. | ||
2. Set up a Python environment with the dependencies in the [requirements.txt file](https://github.com/lincbrain/linc-convert/blob/main/requirements.txt). | ||
1. Fork the [linc-convert](https://github.com/lincbrain/linc-convert) repository and clone it to your computer. | ||
2. Set up a Python environment with the dependencies in the [requirements.txt](https://github.com/lincbrain/linc-convert/blob/main/requirements.txt) file. | ||
3. Within the Python environment, run `mkdocs serve`. This will build the website and start a local webserver (e.g. at http://127.0.0.1:8000) with your documentation. | ||
4. As you continue to edit the markdown files or configuration file, your documentation will be automatically re-built and rendered locally. | ||
5. Commit your changes and submit a pull request. |