go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-04 03:11:55 +02:00
Code Issues Releases Activity
e31f7806dc
goreleaser/www
History
Carlos A Becker e31f7806dc
docs: update schema 
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2022-08-30 22:25:33 -03:00
..
docs docs: update schema 2022-08-30 22:25:33 -03:00
htmltest.yml docs: fix several htmltest issues (#3086) 2022-05-07 01:28:22 -03:00
mkdocs.yml docs: miscellaneous usage and wording improvements (#3152) 2022-06-10 23:04:16 -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 .