go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-06 03:13:48 +02:00
Code Issues Releases Activity
6ff89366ca
goreleaser/www
History
Carlos A Becker bb6181c1bb
docs: document release upload errors
2022-11-29 07:19:50 -03:00
..
docs docs: document release upload errors 2022-11-29 07:19:50 -03:00
htmltest.yml docs: fix htmltest 2022-10-12 00:04:19 -03:00
mkdocs.yml docs: document release upload errors 2022-11-29 07:19:50 -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 .