Skip to content

Commit

Permalink
[docs] local docs hacking howto (#1816)
Browse files Browse the repository at this point in the history
Co-authored-by: decentral1se <[email protected]>
  • Loading branch information
decentral1se and decentral1se authored May 23, 2023
1 parent d0e747c commit 282be6f
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,17 @@ The process for documentation pull requests is a bit looser than the process for

If you see something in the documentation that's missing, wrong, or unclear, feel free to open a pull request addressing it; you don't necessarily need to open an issue first, but please explain why you're opening the PR in the PR comment.

We support a [Conda](https://docs.conda.io/en/latest/)-based workflow for hacking, building & publishing the documentation. Here's how you can get started locally:

* Install [`miniconda`](https://docs.conda.io/en/latest/miniconda.html)
* Create your conda environment: `conda env create -f ./docs/environment.yml`
* Activate the environment: `conda activate gotosocial-docs`
* Serve locally: `mkdocs serve`

Then you can visit [localhost:8000](http://127.0.0.1:8000/) in your browser to view.

If you don't use Conda, you can read the `docs/environment.yml` to see which dependencies are required and `pip install` them manually.

## Development

### Golang forking quirks
Expand Down

0 comments on commit 282be6f

Please sign in to comment.