fix: unify docs style and fix cross-references#27
Draft
shenxianpeng wants to merge 2 commits into
Draft
Conversation
- Change primary palette from 'indigo' to 'blue' to match cpp-linter-action - Add missing MkDocs features: navigation.footer, content.code.copy, content.code.annotate, search.suggest, search.share, toc.follow, content.tabs.link - Add missing markdown extensions: admonition, pymdownx.highlight, pymdownx.inlinehilite, pymdownx.snippets, toc (with permalink) - Remove toc.integrate (incompatible with toc.follow) - Fix broken links: cpp-linter CLI and cpp-linter-rs now point to real destinations (PyPI and GitHub) instead of non-existent cpp-linter.github.io sub-sites - Add cpp-linter-rs to the quick-reference table - Update pre-commit hooks version from v1.4.0 to v1.5.0 - Fix clang-tools-wheel link to point to GitHub Pages instead of GitHub - Remove unused CSS: heart animation, badge styles, social layer styles, pulse animation, stats-grid (not used by hub site)
✅ Deploy Preview for cpp-linter-github-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Indigo better matches the cpp-linter organization's logo and branding. Also unifies the auto-mode palette which was previously blue (inconsistent with light/dark modes that used indigo).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses documentation style inconsistencies across the cpp-linter organization hub site, aligning it with the
cpp-linter-actionMkDocs configuration (which is the most mature sub-project site).Issues found across all cpp-linter repos
indigo,cpp-linter-actionusesbluegetting-started.mdpointed to non-existentcpp-linter.github.io/cpp-linter/andcpp-linter.github.io/cpp-linter-rs/content.code.copy,search.suggest,search.share,navigation.footer,toc.followthat cpp-linter-action hasadmonition,pymdownx.highlight,tocpermalinksphinx_immaterialvsmaterial), different look & feelclang-tools-pipusesnew_favicon.icovsfavicon.icoelsewhereclang-tools-pipis RST, everything else is Markdown. Header casing varies ("C/C++ Linter Action" vs "cpp-linter-hooks" vs "Clang Tools Docker image")Changes in this PR
1.
mkdocs.yml— Unified theme configindigo→blue(matchescpp-linter-action)toc.integrate(incompatible withtoc.follow)cpp-linter-action:navigation.footer,content.code.annotate,content.code.copy,content.tabs.link,search.suggest,search.share,toc.followadmonition,pymdownx.highlight,pymdownx.inlinehilite,pymdownx.snippets,tocwith permalink2.
docs/getting-started.md— Fixed cross-referencescpp-linter CLIlink → PyPI (pypi.org/project/cpp-linter/) instead of non-existent GitHub Pages sitecpp-linter-rslink → GitHub repo instead of non-existent GitHub Pages sitecpp-linter-rsto the quick-reference table (was missing)clang-tools-wheellink to use GitHub Pages3.
docs/index.md— Version updaterevfromv1.4.0tov1.5.0(current latest)4.
docs/stylesheets/extra.css— CSS cleanup@keyframes gradientShift(orphaned).stats-grid/.statstyles (HTML was commented out)@keyframes heart+.mdx-heart/.mdx-badge/.mdx-socialstyles (only used by cpp-linter-action)@keyframes pulse(not used by hub)Follow-up work (separate PRs in other repos)
new_favicon.ico→favicon.icofor consistencyextra.css: Remove ~100 lines of dead social/badge/pulse CSS also not used there