diff options
| author |  decentral1se <1991377+decentral1se@users.noreply.github.com> | 2023-05-23 17:38:39 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2023-05-23 17:38:39 +0200 |
| commit | 282be6f26dd4dfb57c3a21b92b756c40c05b2e6c (patch) | |
| tree | bd74466d2dd98ce54fbfeccb158f10b1cade4233 | |
| parent | [docs] code highlighting configuration (#1817) (diff) | |
| download | gotosocial-282be6f26dd4dfb57c3a21b92b756c40c05b2e6c.tar.xz | |
[docs] local docs hacking howto (#1816)v0.9.0
Co-authored-by: decentral1se <cellarspoon@riseup.net>
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c24e81221..a706119e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 |