Skip to content

Update README.md and requirements.txt to MkDocs NG packages #20

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

Open
shenxianpeng wants to merge 2 commits into
base: main
Choose a base branch
from
+3 −3
Open

Update README.md and requirements.txt to MkDocs NG packages #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
887860a
Update README.md and requirements.txt for MkDocs NG packages
shenxianpeng May 1, 2026
4f63770
Fix badge formatting in README.md
shenxianpeng May 1, 2026
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Website](https://img.shields.io/static/v1?logo=googlechrome&logoColor=white&label=Website&message=cpp-linter.github.io&color=yellow)](https://cpp-linter.github.io/)
[![GitHub Org](https://img.shields.io/badge/github-cpp--linter-181717?logo=github)](https://github.com/cpp-linter)
[![License](https://img.shields.io/github/license/cpp-linter/cpp-linter.github.io)](LICENSE)
[![MkDocs](https://img.shields.io/badge/docs-MkDocs%20Material-526CFE?logo=materialformkdocs&logoColor=white)](https://cpp-linter.github.io/)
[![MkDocs](https://img.shields.io/badge/docs-MkDocs%20NG%20Material-526CFE?logo=materialformkdocs&logoColor=white)](https://cpp-linter.github.io/)

Documentation website for the `cpp-linter` project and organization.

Expand Down
4 changes: 2 additions & 2 deletions docs/requirements.txt
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@2bndy5 2bndy5 May 1, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does mkdocs-ng provide an alias to import from mkdocs?

The mkdocs-include-markdown-plugin depends on installing og mkdocs. This means that both mkdocs-ng and mkdocs@v1.x would be installed. Should be no problem if mkdocs-ng doesn't change how plugins are used.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
markdown-gfm-admonition
mkdocs
mkdocs-ng
mkdocs-ng-material
mkdocs-include-markdown-plugin
mkdocs-material