mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
7baf594a13
I have sorted the GoReleaser configuration YAML code examples as follows: ```yaml # This feature is only available in GoReleaser Pro. # Since: v1.17 (pro) # Default: . # Templates: allowed # Required ``` |
||
|---|---|---|
| .. | ||
| docs | ||
| htmltest.yml | ||
| mkdocs.yml | ||
| README.md | ||
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.