Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 3 additions & 39 deletions docs/assets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
/* The brand blue only reaches 4.2:1 on white; links need 4.5:1. */
--cc-link: #176b89;

/* The hero sits on brand blue, so its button is white rather than branded. */
--cc-hero-button-bg: #ffffff;

--md-primary-fg-color: var(--cc-brand);
--md-primary-fg-color--light: var(--cc-brand-light);
--md-primary-fg-color--dark: var(--cc-brand-dark);
Expand All @@ -23,38 +26,6 @@
--md-typeset-a-color: var(--cc-link);
}

/* Landing page -------------------------------------------------------------
The hero is the first thing a visitor sees, so it carries the value
proposition rather than a badge wall. */
.cc-hero {
text-align: center;
padding: 3.5rem 1rem 2.5rem;
}

.cc-hero h1 {
font-size: 2.9rem;
line-height: 1.15;
font-weight: 800;
letter-spacing: -0.02em;
margin: 0 0 0.6rem;
}

.cc-hero p {
font-size: 1.05rem;
max-width: 40rem;
margin: 0 auto 1.8rem;
color: var(--md-default-fg-color--light);
}

.cc-hero .md-button {
margin: 0.3rem;
}

/* Hide the redundant H1 that MkDocs renders above a custom hero. */
.cc-hero + hr {
display: none;
}

/* Feature grid: uses Material's card grid, tightened up a little. */
.md-typeset .grid.cards > ul > li {
border-radius: 0.4rem;
Expand All @@ -77,13 +48,6 @@
vertical-align: top;
}

/* In the rule index tables only, keep codes, names and CLI flags on one line
so the tables stay scannable. Other tables hold long regexes and lists that
must stay wrappable. */
.md-typeset table.rules-index td code {
white-space: nowrap;
}

/* Sidebar section headings ("Getting started", "Reference", ...) */
.md-nav__item--section > .md-nav__link {
font-weight: 700;
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/posts/configuring-commit-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ require_signed_off_by = false
ignore_authors = ["dependabot[bot]", "renovate[bot]", "copilot[bot]"]

[branch]
# https://conventional-branch.github.io/
# https://conventionalbranch.org
conventional_branch = true
allow_branch_types = ["feature", "bugfix", "hotfix", "release", "chore", "feat", "fix"]
```
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/posts/introducing-commit-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ pull request.
You do not need a config file to begin. With no `cchk.toml`, Commit Check
applies lenient, sensible defaults: commit messages should follow
[Conventional Commits](https://www.conventionalcommits.org/) and branch names
should follow the [Conventional Branch](https://conventional-branch.github.io/)
should follow the [Conventional Branch](https://conventionalbranch.org/)
convention. That is enough to get value on day one.

```bash
Expand Down
3 changes: 2 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Configuration

`commit-check` can be configured in three ways with the following priority (highest to lowest):
`commit-check` reads its settings from four places, in this priority order
(highest to lowest):

1. **Command-line arguments** (`--subject-imperative=true`)
2. **Environment variables** (`CCHK_SUBJECT_IMPERATIVE=true`)
Expand Down
Binary file removed docs/demo.gif
Binary file not shown.
39 changes: 0 additions & 39 deletions docs/demo.tape

This file was deleted.

7 changes: 6 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@ description: Enforce commit message, branch naming, author and signoff standards

<!-- markdownlint-disable MD041 MD033 MD036 MD025 -->

# Commit Check
<!-- The visible page title is the hero's, rendered full-width by
overrides/home.html. This heading is hidden, and exists only because
Material injects a title of its own — the nav label, "Home" — into any
page whose content has none, which would compete with the hero. -->

# Commit Check { .cc-page-title }

## One config, enforced everywhere

Expand Down
4 changes: 2 additions & 2 deletions docs/overrides/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

{% block hero %}
<div class="hero">
<h1 id="cc-linting-that-just-works">Commit Check</h1>
<h1 id="commit-check">Commit Check</h1>
<p>
Clean commits. Clear standards.
</p>
<p>
<a class="md-button md-button--primary" href="getting-started/quickstart/">
<a class="md-button md-button--primary" href="getting-started/">
Get started
<span class="twemoji">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m13.13 22.19-1.63-3.83c1.57-.58 3.04-1.36 4.4-2.27zM5.64 12.5l-3.83-1.63 6.1-2.77C7 9.46 6.22 10.93 5.64 12.5M21.61 2.39S16.66.269 11 5.93c-2.19 2.19-3.5 4.6-4.35 6.71-.28.75-.09 1.57.46 2.13l2.13 2.12c.55.56 1.37.74 2.12.46A19.1 19.1 0 0 0 18.07 13c5.66-5.66 3.54-10.61 3.54-10.61m-7.07 7.07c-.78-.78-.78-2.05 0-2.83s2.05-.78 2.83 0c.77.78.78 2.05 0 2.83s-2.05.78-2.83 0m-5.66 7.07-1.41-1.41zM6.24 22l3.64-3.64c-.34-.09-.67-.24-.97-.45L4.83 22zM2 22h1.41l4.77-4.76-1.42-1.41L2 20.59zm0-2.83 4.09-4.08c-.21-.3-.36-.62-.45-.97L2 17.76z"></path></svg>
Expand Down
11 changes: 11 additions & 0 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
{% extends "base.html" %}

{# The landing page sets `title: Commit Check` so its social card and search
entry are not labelled "Home". Material appends the site name to any page
that carries a meta title, which on this one page repeats it. #}
{% block htmltitle %}
{% if page.is_homepage %}
<title>{{ config.site_name }}</title>
{% else %}
{{ super() }}
{% endif %}
{% endblock %}

{% block extrahead %}
<link rel="apple-touch-icon" sizes="180x180" href="{{ base_url }}/static/apple-touch-icon.png">
<link rel="icon" type="image/x-icon" href="{{ base_url }}/static/favicon.ico">
Expand Down
4 changes: 4 additions & 0 deletions docs/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
User-agent: *
Allow: /

Sitemap: https://commit-check.com/sitemap.xml
Binary file removed docs/static/logo.png
Binary file not shown.
Loading