1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2024-12-27 01:33:39 +02:00
goreleaser/www/mkdocs.yml
Carlos Alexandro Becker 248c7fcb5f
docs: update
Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
2024-10-16 01:22:12 -03:00

269 lines
8.5 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/
hooks:
- docs/overrides/hooks/shortcodes.py
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
icon:
admonition:
example: material/professional-hexagon
palette:
- media: "(prefers-color-scheme: light)" # Light mode
scheme: default
toggle:
icon: material/lightbulb-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)" # Dark mode
scheme: slate
primary: light blue
accent: indigo
toggle:
icon: material/lightbulb
name: Switch to light mode
features:
- announce.dismiss
- search.suggest
- search.highlight
- search.share
- content.code.copy
- content.action.edit
- navigation.footer
- navigation.instant
- navigation.tracking
- navigation.tabs
- content.tabs.link
plugins:
- search
- redirects:
redirect_maps:
discord.md: https://discord.gg/rYWM4AZvy7
github.md: https://github.com/goreleaser
linkedin.md: https://www.linkedin.com/company/goreleaser/
mastodon.md: https://fosstodon.org/@goreleaser
twitter.md: https://twitter.com/goreleaser
d.md: https://discord.gg/RGEBtg8vQ6
g.md: https://github.com/goreleaser
l.md: https://www.linkedin.com/company/goreleaser/
m.md: https://fosstodon.org/@goreleaser
t.md: https://twitter.com/goreleaser
"customization/build.md": customization/builds.md
- minify:
minify_html: true
- include-markdown
- tags
# - meta
- blog:
post_url_format: "{slug}"
- rss:
match_path: blog/posts/.*
date_from_meta:
as_creation: date
extra:
extra:
analytics:
provider: google
property: "G-3MZGQS8EPS"
social:
- icon: fontawesome/brands/x-twitter
link: https://x.com/goreleaser
- icon: fontawesome/brands/mastodon
link: https://fosstodon.org/@goreleaser
- icon: fontawesome/brands/github
link: https://github.com/goreleaser
- icon: fontawesome/brands/discord
link: /discord
nav:
- Home: index.md
- Getting Started:
- intro.md
- install.md
- quick-start.md
- how-it-works.md
- Limitations:
- limitations/cgo.md
- limitations/semver.md
- Customization:
- customization/index.md
- General:
- customization/includes.md
- customization/templates.md
- customization/templatefiles.md
- customization/env.md
- customization/hooks.md
- customization/dist.md
- customization/project.md
- customization/git.md
- Split & Merge: customization/partial.md
- Build:
- customization/builds.md
- customization/verifiable_builds.md
- customization/monorepo.md
- customization/universalbinaries.md
- customization/upx.md
- Package & Archive:
- customization/archive.md
- customization/source.md
- Linux Packages: customization/nfpm.md
- customization/app_bundles.md
- customization/dmg.md
- customization/msi.md
- customization/checksum.md
- Snaps: customization/snapcraft.md
- Chocolatey: customization/chocolatey.md
- Docker: customization/docker.md
- Docker Manifests: customization/docker_manifest.md
- Ko: customization/ko.md
- SBOMs: customization/sbom.md
- customization/reportsizes.md
- customization/metadata.md
- Sign & Notarize:
- Binaries: customization/binary_sign.md
- Archives, installers, packages, and checksums: customization/sign.md
- Docker Images and Manifests: customization/docker_sign.md
- customization/notarize.md
- Publish:
- Hooks: customization/beforepublish.md
- customization/release.md
- customization/snapshots.md
- customization/nightlies.md
- customization/blob.md
- Cloudsmith: customization/cloudsmith.md
- Fury: customization/fury.md
- customization/dockerhub.md
- customization/homebrew.md
- customization/winget.md
- NUR: customization/nix.md
- AUR: customization/aur.md
- Krew: customization/krew.md
- Scoop: customization/scoop.md
- customization/changelog.md
- customization/upload.md
- customization/artifactory.md
- Custom: customization/publishers.md
- SCM:
- scm/github.md
- scm/gitlab.md
- scm/gitea.md
- customization/milestone.md
- Announce:
- About: customization/announce/index.md
- customization/announce/bluesky.md
- customization/announce/discord.md
- customization/announce/linkedin.md
- customization/announce/mastodon.md
- customization/announce/mattermost.md
- customization/announce/opencollective.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
- 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
- ci/woodpecker.md
- More resources:
- sponsors.md
- users.md
- deprecations.md
- experiments.md
- Common errors:
- errors/version.md
- errors/dirty.md
- errors/multiple-tokens.md
- errors/release-upload.md
- errors/docker-build.md
- errors/no-main.md
- errors/build.md
- errors/resource-not-accessible-by-integration.md
- errors/no-history.md
- errors/multiple-binaries-archive.md
- errors/scoop-archive.md
- Cookbooks:
- About: cookbooks/index.md
- Blog Posts: cookbooks/blog-posts.md
- Add a new cookbook: cookbooks/contributing.md
- cookbooks/private-monorepo-public-release.md
- cookbooks/multi-platform-docker-images.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
- Command Line Usage:
- cmd/goreleaser.md
- cmd/goreleaser_init.md
- cmd/goreleaser_healthcheck.md
- cmd/goreleaser_check.md
- cmd/goreleaser_changelog.md
- cmd/goreleaser_build.md
- cmd/goreleaser_release.md
- cmd/goreleaser_continue.md
- cmd/goreleaser_publish.md
- cmd/goreleaser_announce.md
- cmd/goreleaser_completion.md
- cmd/goreleaser_completion_bash.md
- cmd/goreleaser_completion_fish.md
- cmd/goreleaser_completion_powershell.md
- cmd/goreleaser_completion_zsh.md
- cmd/goreleaser_jsonschema.md
- contributing.md
- links.md
- Get Pro: pro.md
- Blog:
- blog/index.md
markdown_extensions:
- admonition
- codehilite
- meta
- toc:
permalink: true
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- footnotes
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg