diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index 7d4e8f0..8d4ba0b 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -81,7 +81,7 @@ jobs: run: echo "${PR_TITLE}" | committed --config "${COMMITTED_CONFIG}" --commit-file - - uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0 with: - node-version: latest + node-version: lts/* - name: spell check working-directory: project-repo env: diff --git a/README.md b/README.md index 1ea89e0..b80b314 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ -# Org Metadata +# mkdocs-ng/.github -Global configurations and assets for the mkdocs-ng organization on GitHub. +Organization-wide files for [MkDocs NG](https://github.com/mkdocs-ng): + +- `profile/README.md`: the organization's GitHub front page. +- `assets/`: the MkDocs NG logo (`mkdocs-ng-logo.svg`, `mkdocs-ng-logo-dark.svg` + for dark backgrounds, `favicon.svg` for small sizes). Earlier logo drafts are + in `assets/archive/`. +- `.github/workflows/`: reusable workflows shared by the organization's + repositories, such as `pr-labeler.yml`. diff --git a/assets/.gitkeep b/assets/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/assets/ChatGPT Image Apr 23, 2026 at 01_22_28 AM.png b/assets/archive/mkdocs-ng-avatar-2026-04.png similarity index 100% rename from assets/ChatGPT Image Apr 23, 2026 at 01_22_28 AM.png rename to assets/archive/mkdocs-ng-avatar-2026-04.png diff --git a/assets/mkdocs-ng-v4-1024.png b/assets/archive/mkdocs-ng-v4-1024.png similarity index 100% rename from assets/mkdocs-ng-v4-1024.png rename to assets/archive/mkdocs-ng-v4-1024.png diff --git a/assets/mkdocs-ng-v4.png b/assets/archive/mkdocs-ng-v4.png similarity index 100% rename from assets/mkdocs-ng-v4.png rename to assets/archive/mkdocs-ng-v4.png diff --git a/assets/mkdocs-ng-v4.svg b/assets/archive/mkdocs-ng-v4.svg similarity index 100% rename from assets/mkdocs-ng-v4.svg rename to assets/archive/mkdocs-ng-v4.svg diff --git a/assets/favicon.svg b/assets/favicon.svg new file mode 100644 index 0000000..050c59d --- /dev/null +++ b/assets/favicon.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/assets/mkdocs-ng-logo-dark.svg b/assets/mkdocs-ng-logo-dark.svg new file mode 100644 index 0000000..3846ab2 --- /dev/null +++ b/assets/mkdocs-ng-logo-dark.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/assets/mkdocs-ng-logo.svg b/assets/mkdocs-ng-logo.svg new file mode 100644 index 0000000..4ff21ff --- /dev/null +++ b/assets/mkdocs-ng-logo.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/profile/README.md b/profile/README.md index 6bf8115..fd5fdb6 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,17 +1,53 @@ - + -## MkDocs NG +

+ + + MkDocs NG + +

-[MkDocs](https://www.mkdocs.org/) is a great tool — but its upstream development has largely stalled. -Existing forks didn't quite hit the mark, so this organization exists to keep the project alive and moving forward. +

MkDocs NG

-This is a spare-time effort by someone who uses MkDocs and doesn't want to watch a good thing quietly fall apart. +

+ The maintained MkDocs that keeps your plugins working. +

-### Projects +

+ Documentation · + Switching from MkDocs · + Discussions +

-* [mkdocs](https://github.com/mkdocs-ng/mkdocs) — Active fork of MkDocs core +MkDocs NG continues [MkDocs](https://github.com/mkdocs/mkdocs) where upstream +development stopped. It is a drop-in replacement: the same `mkdocs` command, +the same `mkdocs.yml`, and the same plugins and themes. -## Contributing 💪 +```sh +pip install mkdocs-ng +``` -If you rely on MkDocs and want to help keep it going, contributions of any size are very welcome — -bug reports, fixes, documentation, or just spreading the word. +## Projects + +| Project | What it is | Install | +| --- | --- | --- | +| [**MkDocs NG**](https://github.com/mkdocs-ng/mkdocs) | The static site generator. Python 3.10 to 3.15, built-in `llms.txt`, and many long-standing upstream bugs fixed. | `pip install mkdocs-ng` | +| [**Sumi**](https://github.com/mkdocs-ng/mkdocs-sumi) | A local-first documentation theme: docs, landing page, blog and releases from plain Markdown. | `pip install mkdocs-sumi` | +| [**MkDocs NG Material**](https://github.com/mkdocs-ng/mkdocs-material) | Material for MkDocs, maintained with security and bug fixes. | `pip install mkdocs-ng-material` | +| [**Catalog**](https://github.com/mkdocs-ng/catalog) | A ranked list of 300 plugins, themes and recipes for MkDocs. | | + +## Why MkDocs NG + +- **Your plugins keep working.** Thirty of the most used plugins are tested + against every change. +- **Ready for AI tools.** Every site can publish `llms.txt` and a Markdown copy + of each page. +- **Offline by default.** The built-in themes load nothing from CDNs and + include no analytics. + +## Get involved + +Questions go to [Discussions](https://github.com/orgs/mkdocs-ng/discussions), +bugs to the issue tracker of the project they affect. Fixes, documentation and +plugin compatibility reports are all welcome; see the +[contributing guide](https://mkdocs-ng.github.io/mkdocs/about/contributing/).