go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-16 03:52:12 +02:00
Code Issues Releases Activity
f544c5ce69
goreleaser/www
History
CC11001100 b4a4ca1716
docs: fix list item count (#3816) 
Hello, I found a number error in the document when I consulted the
document, so I propose a pr to fix it
2023-03-01 09:46:56 -03:00
..
docs docs: fix list item count (#3816) 2023-03-01 09:46:56 -03:00
htmltest.yml build: fix htmltest config 2023-01-16 22:14:23 -03:00
mkdocs.yml docs: ordering 2023-03-01 09:46:05 -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 .