### Hugo Site Configuration Example Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/themes/conventional-commits/README.md Example `config.yaml` file for setting up the Conventional Commits Hugo theme. Includes base URL, language settings, versioning, welcome message, license, and footer configurations. ```yaml baseURL: 'http://conventional-commits.org/' languageCode: en-us title: Conventional Commits theme: conventional-commits # Language defaultContentLanguageInSubdir: true defaultContentLanguage: "en" languages: en: weight: 1 languageName: "English" it: weight: 2 languageName: "Italian" # Content params: versions: current: 1.0.0-beta.2 list: - label: 1.0.0-beta url: 'https://github.com/conventional-commits/conventionalcommits.org' - label: 1.0.0-beta.1 url: 'https://github.com/conventional-commits/conventionalcommits.org' - label: 1.0.0-beta.2 url: 'https://github.com/conventional-commits/conventionalcommits.org' welcome: description: A specification made for write standardized and useful commit messages image: 'https://path-to-image' actions: - label: Read the specs url: 'https://github.com/conventional-commits/conventionalcommits.org' - label: GitHub url: 'https://github.com/conventional-commits/conventionalcommits.org' license: title: License action: label: Creative Commons - CC BY 3.0 url: 'https://creativecommons.org/licenses/by/3.0/' footer: logos: - name: github url: 'https://github.com/conventional-commits/conventionalcommits.org' ``` -------------------------------- ### Revert Commit Example Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/content/v1.0.0/index.md An example of how to format a revert commit using the `revert` type and a footer to reference reverted commit SHAs. ```git commit message revert: let us never again speak of the noodle incident Refs: 676104e, a215868 ``` -------------------------------- ### Commit with Both '!' and BREAKING CHANGE Footer Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/content/v1.0.0/index.md An example combining both the '!' notation and a 'BREAKING CHANGE' footer for maximum clarity on breaking changes. ```markdown feat!: drop support for Node 6 BREAKING CHANGE: use JavaScript features not available in Node 6. ``` -------------------------------- ### Commit with Description and Breaking Change Footer Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/content/v1.0.0/index.md Example of a 'feat' type commit that includes a description and a 'BREAKING CHANGE' footer. ```markdown feat: allow provided config object to extend other configs BREAKING CHANGE: `extends` key in config file is now used for extending other config files ``` -------------------------------- ### Commit with Scope Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/content/v1.0.0/index.md Example of a 'feat' type commit that includes a scope to specify the area of the feature. ```markdown feat(lang): add Polish language ``` -------------------------------- ### Development Script Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/themes/conventional-commits/README.md Runs the development server for the Hugo theme. Use this for local development and testing changes. ```bash npm run start ``` -------------------------------- ### Production Script Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/themes/conventional-commits/README.md Builds the Hugo site for production deployment. This script generates the static files for the website. ```bash npm run build ``` -------------------------------- ### Google Analytics Configuration Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/themes/conventional-commits/layouts/partials/head.html This snippet configures Google Analytics tracking for the website. It initializes the data layer and sets up the tracking ID. ```javascript window.dataLayer = window.dataLayer || []; function gtag(){ dataLayer.push(arguments); } gtag('js', new Date()); gtag('config', 'UA-2173276-5'); ``` -------------------------------- ### Commit with Multi-Paragraph Body and Multiple Footers Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/content/v1.0.0/index.md Illustrates a commit with a detailed, multi-paragraph body and multiple 'Refs' and 'Reviewed-by' footers. ```markdown fix: prevent racing of requests Introduce a request id and a reference to latest request. Dismiss incoming responses other than from latest request. Remove timeouts which were used to mitigate the racing issue but are obsolete now. Reviewed-by: Z Refs: #123 ``` -------------------------------- ### Commit with Scope and '!' for Breaking Change Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/content/v1.0.0/index.md Shows how to include a scope along with '!' to denote a breaking change within a specific part of the codebase. ```markdown feat(api)!: send an email to the customer when a product is shipped ``` -------------------------------- ### Commit with '!' for Breaking Change Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/content/v1.0.0/index.md Demonstrates using '!' after the type to indicate a breaking change, drawing attention to it. ```markdown feat!: send an email to the customer when a product is shipped ``` -------------------------------- ### Page Title Placeholder Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/themes/conventional-commits/layouts/partials/head.html This is a placeholder for dynamically setting the page title using a template parameter. ```html {{ .Param "Title" }} ``` -------------------------------- ### Commit with No Body Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/content/v1.0.0/index.md A simple 'docs' type commit that only includes a description and no body or footers. ```markdown docs: correct spelling of CHANGELOG ``` -------------------------------- ### Display Conventional Commits Badge Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/README.md Use this markdown to display a badge indicating that your project adheres to the Conventional Commits specification. This badge links to the official Conventional Commits website. ```markdown [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) ``` -------------------------------- ### Commit Message Structure Source: https://github.com/conventional-commits/conventionalcommits.org/blob/master/content/v1.0.0/index.md The standard structure for a Conventional Commit message, including type, optional scope, description, body, and footers. ```markdown [optional scope]: [optional body] [optional footer(s)] ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.