go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-04-11 11:42:15 +02:00
Code Issues Releases Activity
goreleaser/www
History
Jo 960814aea8
docs: fix skip_push parameter to skip_build (#3628) 
Fix the wrong `skip_push` to `skip_build` in `docker.md`.
2022-12-08 09:43:03 -03:00
..
docs
docs: fix skip_push parameter to skip_build (#3628)
2022-12-08 09:43:03 -03:00
htmltest.yml
docs: fix htmltest
2022-10-12 00:04:19 -03:00
mkdocs.yml
docs: errors/build
2022-12-04 10:29:02 -03:00
README.md
feat: mTLS with client certificate (#3302)
2022-08-12 09:44:54 -03:00

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

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 .