Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use 'SUMMARY.md' to describe navigation structure by 'mkdocs-literate-nav' plugin #308

Open
hwhsu1231 opened this issue Jan 23, 2024 · 0 comments · May be fixed by #309
Open

Use 'SUMMARY.md' to describe navigation structure by 'mkdocs-literate-nav' plugin #308

hwhsu1231 opened this issue Jan 23, 2024 · 0 comments · May be fixed by #309

Comments

@hwhsu1231
Copy link
Contributor

Suggestion

I suggest that msys2.github.io use SUMMARY.md to describe its navigation structure by mkdocs-literate-nav plugin, instead of configuring it through the nav field in mkdocs.yml.

By doing this, contributors who want to edit documentation or modify its navigation structure would only need to focus on docs_dir, which is web/.
@hwhsu1231 hwhsu1231 linked a pull request Jan 23, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use 'mkdocs-literate-nav' for navigation hwhsu1231/msys2.github.io
1 participant
@hwhsu1231