mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-03-05 14:55:19 +02:00
2023d4bcc6
<!--
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... -->
Update docs for `winget` to show the default past contains the name as
well.
...
<!-- Why is this change being made? -->
Current doc (and sample value) don't contain the name and this doesn't
match the implementation.
...
<!-- # Provide links to any relevant tickets, URLs or other resources
-->
a82491afe4/internal/pipe/winget/winget.go (L165)
...
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.