go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-10 03:47:03 +02:00
Code Issues Releases Activity
d7921d4638
goreleaser/www
History
Carlos Alexandro Becker d7921d4638 feat(brew): extra_install 
Allows to add manpages and shell completion installs without overriding
the default bin.install.
2023-07-31 09:40:35 -03:00
..
docker docs: include markdown plugin (#4098) 2023-06-13 23:25:18 -03:00
docs feat(brew): extra_install 2023-07-31 09:40:35 -03:00
htmltest.yml build: fix htmltest config 2023-01-16 22:14:23 -03:00
mkdocs.yml feat: metadata mod_timestamp (#4188) 2023-07-15 16:53:52 -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 .