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.

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

docs: Reorganize sidebar in mkdocs.yml #642

Merged
merged 1 commit into from
Jan 17, 2025
Merged

Conversation

saforem2
Copy link
Member

Changes:

  • Re-organize (+ alphabetize) sidebar
  • Group {AI Testbeds, Aurora, Polaris, Crux, Sophia} into Machines section in sidebar

Compare current (left) vs proposed (right):



(@felker I'm gonna submit a separate PR to fix the sidebar CSS)

Copilot Summary

This pull request includes significant updates to the mkdocs.yml configuration file, focusing on enhancing the site structure, theme customization, and plugin integration.

Enhancements to site structure and navigation:

  • Added new sections to the navigation (nav:) including "Facility Policies," "Machines," and "Services," providing a clearer and more organized structure for users. [1] [2] [3] [4] [5]

Theme customization:

  • Introduced a new theme configuration with a custom directory, language settings, color palette, and various features like tabs, instant navigation, and search enhancements.

Additional resources:

  • Included custom CSS and JavaScript files to extend the styling and functionality of the site.

Markdown extensions:

  • Enabled several markdown extensions to enhance content formatting, including footnotes, admonition, code highlighting, and various pymdownx extensions for advanced markdown features.

Validation and analytics:

  • Configured validation rules to handle omitted files, absolute links, unrecognized links, and more, along with integrating Google Analytics for tracking site usage.

mkdocs.yml Show resolved Hide resolved
@felker felker force-pushed the saforem2-mkdocs-sections branch from 8e20c99 to d7709f9 Compare January 17, 2025 05:51
@felker felker merged commit 001eaa4 into main Jan 17, 2025
1 check passed
@felker felker deleted the saforem2-mkdocs-sections branch January 17, 2025 05:51
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.

2 participants