1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-04 03:11:55 +02:00
goreleaser/www/mkdocs.yml
Randy Fay 176336f264
docs: miscellaneous usage and wording improvements (#3152)
* Make sure to do required go mod init before continuing or goreleaser command fails.

* how the release might look like -> what the release might look like

* How does it look like -> What does it look like

* you must therefore -> you must

* Don't use GO111MODULES in example since it's so obsolete

* modules -> verifiable builds

* got you covered -> has you covered
2022-06-10 23:04:16 -03:00

177 lines
4.8 KiB
YAML

site_name: GoReleaser
site_url: https://goreleaser.com
site_description: Deliver Go binaries as fast and easily as possible
copyright: Made with ❤️ by GoReleaser contributors.
repo_name: goreleaser/goreleaser
repo_url: https://github.com/goreleaser/goreleaser
edit_uri: edit/main/www/docs/
theme:
name: material
custom_dir: docs/overrides
language: en
logo: static/avatar.png
favicon: static/favicon.ico
include_search_page: false
search_index_only: true
palette:
- media: "(prefers-color-scheme: light)" # Light mode
scheme: default
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- media: "(prefers-color-scheme: dark)" # Dark mode
scheme: slate
primary: light blue
accent: indigo
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- search.suggest
- search.highlight
- search.share
plugins:
- search
- minify:
minify_html: true
extra:
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/goreleaser
- icon: fontawesome/brands/twitter
link: https://twitter.com/goreleaser
nav:
- Home: index.md
- intro.md
- install.md
- quick-start.md
- how-it-works.md
- Limitations:
- limitations/cgo.md
- limitations/semver.md
- SCM:
- scm/github.md
- scm/gitlab.md
- scm/gitea.md
- Continuous Integration:
- About: ci/index.md
- ci/actions.md
- ci/azurepipelines.md
- ci/circle.md
- ci/cirrus.md
- ci/cloudbuild.md
- ci/codefresh.md
- ci/drone.md
- ci/gitlab.md
- ci/jenkins.md
- ci/semaphore.md
- ci/travis.md
- Customization:
- About: customization/index.md
- Basics:
- customization/includes.md
- customization/templates.md
- customization/env.md
- customization/hooks.md
- customization/dist.md
- customization/project.md
- Build:
- customization/build.md
- customization/verifiable_builds.md
- customization/monorepo.md
- customization/universalbinaries.md
- Packaging and Archiving:
- customization/archive.md
- customization/nfpm.md
- customization/checksum.md
- customization/snapcraft.md
- customization/docker.md
- customization/docker_manifest.md
- customization/sbom.md
- Signing:
- Checksums and artifacts: customization/sign.md
- Docker Images and Manifests: customization/docker_sign.md
- Publish:
- customization/release.md
- customization/snapshots.md
- customization/nightlies.md
- customization/blob.md
- customization/fury.md
- customization/homebrew.md
- customization/aur.md
- customization/krew.md
- customization/scoop.md
- customization/changelog.md
- customization/upload.md
- customization/source.md
- customization/publishers.md
- customization/artifactory.md
- customization/milestone.md
- Announce:
- About: customization/announce/index.md
- customization/announce/discord.md
- customization/announce/linkedin.md
- customization/announce/mattermost.md
- customization/announce/reddit.md
- customization/announce/slack.md
- customization/announce/smtp.md
- customization/announce/teams.md
- customization/announce/telegram.md
- customization/announce/twitter.md
- customization/announce/webhook.md
- Command Line Usage:
- goreleaser: cmd/goreleaser.md
- goreleaser init: cmd/goreleaser_init.md
- goreleaser check: cmd/goreleaser_check.md
- goreleaser changelog: cmd/goreleaser_changelog.md
- goreleaser build: cmd/goreleaser_build.md
- goreleaser release: cmd/goreleaser_release.md
- goreleaser completion: cmd/goreleaser_completion.md
- goreleaser jsonschema: cmd/goreleaser_jsonschema.md
- Common errors:
- errors/dirty.md
- errors/multiple-tokens.md
- errors/docker-build.md
- errors/no-main.md
- errors/resource-not-accessible-by-integration.md
- errors/no-history.md
- deprecations.md
- Cookbooks:
- About: cookbooks/index.md
- Blog Posts: cookbooks/blog-posts.md
- Add a new cookbook: cookbooks/contributing.md
- cookbooks//build-go-modules.md
- cookbooks/cgo-and-crosscompiling.md
- cookbooks/debconf-templates.md
- cookbooks/using-jfrog-cli-to-publish-to-artifactory.md
- cookbooks/publish-to-nexus.md
- cookbooks/release-a-library.md
- cookbooks/semantic-release.md
- cookbooks/set-a-custom-git-tag.md
- cookbooks/using-main.version.md
- cookbooks/override-image-name.md
- cookbooks/goreleaser-xx.md
- Community:
- sponsors.md
- users.md
- contributing.md
- pro.md
- links.md
markdown_extensions:
- admonition
- codehilite
- meta
- toc:
permalink: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- footnotes