mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-03-17 20:47:50 +02:00
708cd8904d
this makes ko run on snapshot builds, too. the image will be `goreleaser.ko.local:[your tags]`, not sure if we can change this, seems like we can't. also fixed a small doc error around it, as well as added a new test to cover this. closes #4683 --------- Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
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.