Skip to content

docs: point GitHub links at the product repo and add a star CTA #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 1 commit into from
Aug 12, 2026
Merged

docs: point GitHub links at the product repo and add a star CTA #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions docs/overrides/home.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ <h1 id="commit-check">Commit Check</h1>
<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>
</span>
</a>
<a class="md-button" href="https://github.com/commit-check/commit-check" title="Star us on GitHub">
<span class="twemoji">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 17.27 18.18 21l-1.64-7.03L22 9.24l-7.19-.61L12 2 9.19 8.63 2 9.24l5.46 4.73L5.82 21z"></path></svg>
</span>
Star on GitHub
</a>
</p>
</div>
{% endblock %}
14 changes: 8 additions & 6 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ site_description: >-
site_author: shenxianpeng
copyright: Copyright &copy; 2022 - 2026 Commit Check

# The documentation covers a family of repositories, so the links point at the
# organisation rather than at any single one. edit_uri is absolute for the same
# reason: the pages live here, not in the repository they document.
repo_url: https://github.com/commit-check/commit-check.com
repo_name: commit-check/commit-check.com
edit_uri: edit/main/docs/
# The header links to the product repository, not to this documentation repo:
# visitors who reach the site from a search or a link are users of commit-check
# itself, and the star/fork counts and the "star" entry point belong to it. The
# pages themselves live here, so edit_uri is an absolute URL pointing back at
# this repository.
repo_url: https://github.com/commit-check/commit-check
repo_name: commit-check/commit-check
edit_uri: https://github.com/commit-check/commit-check.com/edit/main/docs/

docs_dir: docs

Expand Down