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
4b78278292
goreleaser/www
History
Ville Skyttä 4b78278292
docs: runner script fixes (#4112) 
Primary motivation here is to fix the runner script on Linux arm64; see
the first commit. The other two contain some while-at-it cleanups.
2023-06-15 14:34:09 -03:00
..
docker docs: include markdown plugin (#4098) 2023-06-13 23:25:18 -03:00
docs docs: runner script fixes (#4112) 2023-06-15 14:34:09 -03:00
htmltest.yml build: fix htmltest config 2023-01-16 22:14:23 -03:00
mkdocs.yml feat: winget support (#4081) 2023-06-14 23:59:55 -03:00
README.md

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 .