Skip to content

Commit ad7973a

Browse files
shenxianpengshenxianpeng
committed
first commit
0 parents  commit ad7973a

46 files changed

Lines changed: 4596 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Xianpeng Shen (xianpeng.shen@gmail.com)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# commit-check.com
2+
3+
[![Website](https://img.shields.io/static/v1?label=Website&message=commit-check.com&color=2c9ccd&logo=git&logoColor=white)](https://commit-check.com)
4+
5+
Source for [commit-check.com](https://commit-check.com) — the landing page,
6+
the blog, and the documentation for the commit-check family of projects.
7+
8+
## Building locally
9+
10+
```console
11+
$ pip install -r docs/requirements.txt
12+
$ mkdocs serve
13+
```
14+
15+
Or through nox, which manages the environment for you:
16+
17+
```console
18+
$ nox -s docs-live
19+
```
20+
21+
Building the share cards needs cairo on the system (`libcairo2` on Debian and
22+
Ubuntu, `cairo` from Homebrew on macOS). To skip them while writing:
23+
24+
```console
25+
$ SOCIAL_CARDS=false mkdocs serve
26+
```
27+
28+
## Layout
29+
30+
| Path | Contents |
31+
| --- | --- |
32+
| `docs/index.md` | Landing page. Renders through `docs/overrides/home.html`. |
33+
| `docs/getting-started/`, `docs/guides/` | Tutorials and how-to guides. |
34+
| `docs/rules.md`, `docs/configuration.md` | Reference. |
35+
| `docs/blog/` | Blog, published with Material's blog plugin. |
36+
| `docs/overrides/`, `docs/stylesheets/`, `docs/assets/` | Theme, styles, brand assets. |
37+
| `scripts/mkdocs_hooks.py` | Redirect stubs for the URLs the old Sphinx site served. |
38+
39+
## Keeping the reference in sync with the code
40+
41+
`docs/rules.md` and the options table in `docs/configuration.md` describe
42+
behaviour that lives in the
43+
[commit-check](https://github.com/commit-check/commit-check) repository. They
44+
are checked against the installed package in CI rather than maintained by hand
45+
alone, so a rule or option cannot change there without this site failing here.
46+
47+
## Deployment
48+
49+
Pushes to `main` build and publish to GitHub Pages. Pull requests get a Netlify
50+
deploy preview, configured in `netlify.toml`. The custom domain is pinned by
51+
`docs/CNAME`, which MkDocs copies to the site root on every build.

‎docs/CNAME‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
commit-check.com

‎docs/assets/extra.css‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
/* Brand palette -----------------------------------------------------------
2+
Material's "custom" primary/accent read these variables. */
3+
:root {
4+
--cc-brand: #2c9ccd;
5+
--cc-brand-dark: #1e85a8;
6+
--cc-brand-light: #5bb3d9;
7+
/* The brand blue only reaches 4.2:1 on white; links need 4.5:1. */
8+
--cc-link: #176b89;
9+
10+
--md-primary-fg-color: var(--cc-brand);
11+
--md-primary-fg-color--light: var(--cc-brand-light);
12+
--md-primary-fg-color--dark: var(--cc-brand-dark);
13+
--md-accent-fg-color: var(--cc-brand-dark);
14+
}
15+
16+
[data-md-color-scheme="slate"] {
17+
--md-primary-fg-color: var(--cc-brand);
18+
--md-accent-fg-color: var(--cc-brand-light);
19+
--md-typeset-a-color: var(--cc-brand-light);
20+
}
21+
22+
[data-md-color-scheme="default"] {
23+
--md-typeset-a-color: var(--cc-link);
24+
}
25+
26+
/* Landing page -------------------------------------------------------------
27+
The hero is the first thing a visitor sees, so it carries the value
28+
proposition rather than a badge wall. */
29+
.cc-hero {
30+
text-align: center;
31+
padding: 3.5rem 1rem 2.5rem;
32+
}
33+
34+
.cc-hero h1 {
35+
font-size: 2.9rem;
36+
line-height: 1.15;
37+
font-weight: 800;
38+
letter-spacing: -0.02em;
39+
margin: 0 0 0.6rem;
40+
}
41+
42+
.cc-hero p {
43+
font-size: 1.05rem;
44+
max-width: 40rem;
45+
margin: 0 auto 1.8rem;
46+
color: var(--md-default-fg-color--light);
47+
}
48+
49+
.cc-hero .md-button {
50+
margin: 0.3rem;
51+
}
52+
53+
/* Hide the redundant H1 that MkDocs renders above a custom hero. */
54+
.cc-hero + hr {
55+
display: none;
56+
}
57+
58+
/* Feature grid: uses Material's card grid, tightened up a little. */
59+
.md-typeset .grid.cards > ul > li {
60+
border-radius: 0.4rem;
61+
transition: border-color 125ms, box-shadow 125ms;
62+
}
63+
64+
.md-typeset .grid.cards > ul > li:hover {
65+
border-color: var(--cc-brand);
66+
box-shadow: 0 0 0 1px var(--cc-brand);
67+
}
68+
69+
.md-typeset .grid.cards > ul > li > hr {
70+
margin: 0.6rem 0;
71+
}
72+
73+
/* Tables -------------------------------------------------------------------
74+
Cells align to the top so short values line up with a wrapped message. */
75+
.md-typeset table:not([class]) td,
76+
.md-typeset table:not([class]) th {
77+
vertical-align: top;
78+
}
79+
80+
/* In the rule index tables only, keep codes, names and CLI flags on one line
81+
so the tables stay scannable. Other tables hold long regexes and lists that
82+
must stay wrappable. */
83+
.md-typeset table.rules-index td code {
84+
white-space: nowrap;
85+
}
86+
87+
/* Sidebar section headings ("Getting started", "Reference", ...) */
88+
.md-nav__item--section > .md-nav__link {
89+
font-weight: 700;
90+
color: var(--md-default-fg-color);
91+
}

‎docs/assets/favicon.svg‎

Lines changed: 8 additions & 0 deletions
Loading

‎docs/assets/logo.svg‎

Lines changed: 13 additions & 0 deletions
Loading

‎docs/blog/.authors.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
authors:
2+
shenxianpeng:
3+
name: Xianpeng Shen
4+
description: Creator
5+
avatar: https://avatars.githubusercontent.com/u/3353385?v=4

‎docs/blog/author/team.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# The Commit Check Team
2+
3+
A small group of people dedicated to making commit-check solutions better.

‎docs/blog/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Blog
2+
3+
News, updates, and resources from the commit-check organization.

0 commit comments

Comments
 (0)