mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-08 03:31:59 +02:00

History

Carlos Alexandro Becker 9ce21d3b95 fix: invalid jsonschema closes https://github.com/goreleaser/goreleaser/issues/4511 Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>		2023-12-31 14:43:39 -03:00
..
docs	fix: invalid jsonschema	2023-12-31 14:43:39 -03:00
htmltest.yml	docs: blog (#4264 )	2023-09-14 13:53:40 -03:00
mkdocs.yml	docs: fix discord link	2023-11-04 02:42:53 +00: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 .