Use index page titles for auto-generated section names#54
Open
shenxianpeng wants to merge 2 commits intomainfrom
Open
Use index page titles for auto-generated section names#54shenxianpeng wants to merge 2 commits intomainfrom
shenxianpeng wants to merge 2 commits intomainfrom
Conversation
shenxianpeng
force-pushed
the
feature/smart-section-titles
branch
2 times, most recently
from
c1cf5e7 to
25e22b9
Compare
When the 'nav' configuration is not explicitly set, MkDocs generates navigation sections from directory names. This change updates those auto-generated section titles to use the index page's title instead of the raw directory name when an index page exists in the section. For example, an 'about/' directory with 'about/index.md' whose title is 'About this Project' will now show 'About this Project' as the section name instead of 'about'. This only applies after pages have been read/rendered (titles are resolved from metadata or headings), and only affects sections that contain an index page. Fixes #3656, #3356
shenxianpeng
force-pushed
the
feature/smart-section-titles
branch
from
005c1fe to
5a048db
Compare
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
1 participant
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.
When the 'nav' configuration is not explicitly set, MkDocs generates navigation sections from directory names. This change updates those auto-generated section titles to use the index page's title instead of the raw directory name when an index page exists in the section.
For example, an 'about/' directory with 'about/index.md' whose title is 'About this Project' will now show 'About this Project' as the section name instead of 'about'.
This only applies after pages have been read/rendered (titles are resolved from metadata or headings), and only affects sections that contain an index page.
Fixes mkdocs/mkdocs#3356
Type of Change
Checklist
docs/about/release-notes.mdupdated (if applicable)