mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-03-25 21:29:14 +02:00
We should not imply the target_commitish, as some users might want to have the code in one repo and the releases in another (e.g. private code, public releases), so the commit might not be there. We should instead allow the user to set the `target_commitish` (or not), and pass it down to the github api. refs 95bba02211a2b88426826ff36a3fd1b424a1d5a7 refs #3044 refs #3330 Signed-off-by: Carlos A 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
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 .