mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-02-09 13:36:56 +02:00
5c4c7de539
<!-- If applied, this commit will... -->
Fix the deprecation notice page to reference the correct new flag
replacing `--rm-dist`
...
<!-- Why is this change being made? -->
The documentation for this deprecation seems incorrect, and live on the
main page.
...
<!-- # Provide links to any relevant tickets, URLs or other resources
-->
https://goreleaser.com/deprecations/#-rm-dist
...
I used this commit to reference what it was being changed to:
4954815ae4
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
NOTE to M1/M2 mac owners
If running on an arm64-based mac (M1 or M2, aka "Applie Silicon"), you may find this method quite slow. Until multiarch docker images can be built and made available, you may wish to build your own via:
git clone git@github.com:squidfunk/mkdocs-material.git
docker build -t docker.io/squidfunk/mkdocs-material .