xsteadfastx/conventionalcommits.org
1
0
Fork 0
mirror of https://github.com/conventional-commits/conventionalcommits.org.git synced 2024-11-15 10:55:16 +01:00
Code Issues Projects Releases Wiki Activity
b7fc792009
conventionalcommits.org/themes/conventional-commits/README.md
Damiano Petrungaro 87d94e3afe style: Move to new UI
2018-09-16 23:40:02 +02:00

1.6 KiB
Raw Blame History

hugo conventional commits theme

Copy hugo-conventional-commits-theme inside your my-hugo-site/theme

config.yaml example

All config params are optionals.

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'

Apply theme changes

Development script

npm run start

Production script

npm run build

Shortcodes

  • banner-image
    • src (optional) | default: static/img/git-flow.png