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
6 changes: 6 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ jobs:

- name: Build site
run: pipx run nox -s docs
env:
# Sumi's `repo_stars` reads the repository's star count from the
# GitHub API at build time. The token keeps that lookup clear of the
# anonymous rate limit runners can share; without it the build still
# passes and the header shows the plain GitHub icon.
GITHUB_TOKEN: ${{ github.token }}

- name: Upload site as pages artifact
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
# depends on, and Sumi, its documentation theme. Sumi brings its own blog,
# search palette and fonts, so nothing else is needed.
mkdocs-ng==1.11.0
mkdocs-sumi==0.4.1
mkdocs-sumi==0.4.3
pymdown-extensions==12.3
16 changes: 16 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,22 @@ theme:
navigation_tabs: false
# The preview image for pages that do not set their own `image:`.
social_image: assets/social.png
# Links beside the brand and a button at the end of the header. A link is
# highlighted on the pages whose URL starts with its path or one of its
# `match` prefixes; Pricing points into the homepage, so it never is.
header_links:
- text: Docs
link: getting-started.md
match: [guides/, configuration/, example/, troubleshoot/, migration/, compare/]
- {text: Rules, link: rules.md}
- {text: Pricing, link: "index.md#pricing"}
- {text: Blog, link: blog/}
- {text: Changelog, link: changelog.md}
header_button:
text: Install App
link: https://github.com/apps/commit-check
# The repository's star count on its icon, read from GitHub at build time.
repo_stars: true

extra_css:
# Brand colours and typography. The landing page adds its own layout in
Expand Down