xsteadfastx/conventionalcommits.org
1
0
Fork 0
mirror of https://github.com/conventional-commits/conventionalcommits.org.git synced 2024-11-15 02:45:15 +01:00
Code Issues Projects Releases Wiki Activity
a09af7d21a
conventionalcommits.org/themes/conventional-commits
History
Silvia Rebelo 9156f6659e style: Welcome page tweaks for long texts. Removing Prettier unnecessary changes
2018-10-26 12:41:28 +02:00
..
archetypes style: Move to new UI 2018-09-16 23:40:02 +02:00
layouts feat(seo): Improve SEO of the website 2018-10-13 22:54:48 +02:00
static style: Welcome page tweaks for long texts. Removing Prettier unnecessary changes 2018-10-26 12:41:28 +02:00
.editorconfig style: Move to new UI 2018-09-16 23:40:02 +02:00
.gitignore chore: Remove compiled js and css files 2018-10-25 01:07:20 +02:00
LICENSE style: Move to new UI 2018-09-16 23:40:02 +02:00
package-lock.json style: Move to new UI 2018-09-16 23:40:02 +02:00
package.json style: Move to new UI 2018-09-16 23:40:02 +02:00
README.md style: Move to new UI 2018-09-16 23:40:02 +02:00
theme.toml style: Move to new UI 2018-09-16 23:40:02 +02:00

README.md

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