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
2 changes: 1 addition & 1 deletion .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`.
Empty file removed assets/.gitkeep
Empty file.
File renamed without changes
File renamed without changes
File renamed without changes
6 changes: 6 additions & 0 deletions assets/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions assets/mkdocs-ng-logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions assets/mkdocs-ng-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 46 additions & 10 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,53 @@
<!-- markdownlint-disable MD036 MD041 MD033 -->
<!-- markdownlint-disable MD033 MD041 -->

## MkDocs NG
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/mkdocs-ng/.github/main/assets/mkdocs-ng-logo-dark.svg">
<img src="https://raw.githubusercontent.com/mkdocs-ng/.github/main/assets/mkdocs-ng-logo.svg" width="120" alt="MkDocs NG">
</picture>
</p>

[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.
<h1 align="center">MkDocs NG</h1>

This is a spare-time effort by someone who uses MkDocs and doesn't want to watch a good thing quietly fall apart.
<p align="center">
<strong>The maintained MkDocs that keeps your plugins working.</strong>
</p>

### Projects
<p align="center">
<a href="https://mkdocs-ng.github.io/mkdocs/">Documentation</a> ·
<a href="https://mkdocs-ng.github.io/mkdocs/user-guide/migrating/">Switching from MkDocs</a> ·
<a href="https://github.com/orgs/mkdocs-ng/discussions">Discussions</a>
</p>

* [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/).
Loading