Skip to content

docs: refresh the organization profile and add the logo files - #2

Merged
shenxianpeng merged 2 commits into
mainfrom
brand/profile-refresh
Nov 1, 2026
Merged

shenxianpeng merged 2 commits into
mainfrom
brand/profile-refresh

Conversation

@shenxianpeng

Copy link
Copy Markdown
Member

The organization profile only listed the core repository and described the project as one person's spare-time effort. This replaces it with a proper front page: the new MkDocs NG logo (light and dark), the tagline "The maintained MkDocs that keeps your plugins working.", the install command, a table of the four projects (MkDocs NG, Sumi, MkDocs NG Material, Catalog), why MkDocs NG, and how to get involved.

  • assets/: mkdocs-ng-logo.svg, mkdocs-ng-logo-dark.svg, favicon.svg (vector redraw of the org avatar, same files as mkdocs-ng/mkdocs docs/img/).
  • The previous avatar PNG and the v4 drafts move to assets/archive/.
  • README.md now describes what the repository holds.

The logo URLs in the profile point at assets/ on main, so they show once this is merged.

Before / After

Before is the live profile at https://github.com/mkdocs-ng. After is the new profile/README.md rendered by GitHub's Markdown API, with the logo URLs pointed at this branch so the images load before merge.

Before After
Desktop
Desktop, dark
Mobile (390px)

The profile listed only the core repository. It now introduces MkDocs NG with the new logo and tagline and lists MkDocs NG, Sumi, MkDocs NG Material and the catalog. assets/ gets the vector logo (light, dark, favicon), the same files as mkdocs-ng/mkdocs docs/img; the earlier avatar and v4 drafts move to assets/archive/.
The runner's setup-node step asked for the latest Node, which is now a 27 prerelease that cspell-cli 10 rejects (it needs >=22.18). Use the current LTS for the PR title spell check.
@shenxianpeng
shenxianpeng merged commit e873cb7 into main Nov 1, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant