go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2024-12-29 01:44:39 +02:00
Code Issues Releases Activity
6220db5fb4
goreleaser/www
History
actions-user 4a398954ed chore: docs auto-update
2022-09-30 12:27:58 +00:00
..
docs chore: docs auto-update 2022-09-30 12:27:58 +00:00
htmltest.yml docs: fix several htmltest issues (#3086) 2022-05-07 01:28:22 -03:00
mkdocs.yml fix: binary archive when multiple builds (#3385) 2022-09-16 23:47:06 -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 .