mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-02-13 13:48:40 +02:00
b05a62fddc
<!-- Hi, thanks for contributing! Please make sure you read our CONTRIBUTING guide. Also, add tests and the respective documentation changes as well. --> <!-- If applied, this commit will... --> ... <!-- Why is this change being made? --> Brew linter says that old constructions can't be used in case of submitting to brew-core <!-- # Provide links to any relevant tickets, URLs or other resources --> ...
Documentation
Documentation is written in mkdocs and there are a few extensions that allow richer authoring than markdown.
To iterate with documentation, therefore, it is recommended to run the mkdocs server and view your pages in a browser.
Prerequisites
With nix
If you have nix installed, you can:
nix develop .#docs
To drop into a shell with all the needed dependencies.
Edit the docs
After installing mkdocs and extensions, build and run the documentation locally:
task docs:serve
The site will soon be available at http://localhost:8000 and auto-update after changes.