Repository navigation
docs: refresh the organization profile and add the logo files - #2
Merged
Merged
Conversation
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.
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
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.
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.
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.mdrendered by GitHub's Markdown API, with the logo URLs pointed at this branch so the images load before merge.