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

Alphabetize documentation sidenav elements #5080

Merged
merged 5 commits into from
May 7, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
373 changes: 193 additions & 180 deletions side-navigation.yaml
Original file line number Diff line number Diff line change
@@ -1,194 +1,207 @@
- heading: Welcome
subheadings:
- title: Get started
url: /docs
- title: Building with Vanilla
url: /docs/building-vanilla
- title: Customising Vanilla
url: /docs/customising-vanilla
- title: What's new in {version}
url: /docs/whats-new
- title: Migrating to v4
url: /docs/migration-guide-to-v4
items:
- title: Get started
url: /docs
- title: Building with Vanilla
url: /docs/building-vanilla
- title: Customising Vanilla
url: /docs/customising-vanilla
- title: What's new in {version}
url: /docs/whats-new
- title: Migrating to v4
url: /docs/migration-guide-to-v4
- heading: Base elements
subheadings:
- title: Code
url: /docs/base/code
- title: Forms
url: /docs/base/forms
- title: Reset
url: /docs/base/reset
- title: Separators
url: /docs/base/separators
- title: Tables
url: /docs/base/tables
- title: Typography
url: /docs/base/typography
- title: Paper background
url: /docs/base/paper
ordering: alphabetical
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it work if we move ordering up one level (alongside heading and subheadings, to avoid additional nesting level of items)?

items:
- title: Code
url: /docs/base/code
- title: Forms
url: /docs/base/forms
- title: Reset
url: /docs/base/reset
- title: Separators
url: /docs/base/separators
- title: Tables
url: /docs/base/tables
- title: Typography
url: /docs/base/typography
- title: Paper background
url: /docs/base/paper
- heading: Components
subheadings:
- title: Accordion
url: /docs/patterns/accordion
- title: Equal height row
url: /docs/patterns/equal-height-row
- title: Badge
url: /docs/patterns/badge
- title: Breadcrumbs
url: /docs/patterns/breadcrumbs
- title: Buttons
url: /docs/patterns/buttons
- title: Cards
url: /docs/patterns/card
- title: Chips
url: /docs/patterns/chip
- title: Contextual menu
url: /docs/patterns/contextual-menu
- title: Divider
url: /docs/patterns/divider
- title: Empty state
url: /docs/patterns/empty-state
- title: Grid
url: /docs/patterns/grid
- title: Heading icon
url: /docs/patterns/heading-icon
- title: Icons
url: /docs/patterns/icons
- title: Images
url: /docs/patterns/images
- title: Links
url: /docs/patterns/links
- title: List tree
url: /docs/patterns/list-tree
- title: Lists
url: /docs/patterns/lists
- title: Logo section
url: /docs/patterns/logo-section
- title: Matrix
url: /docs/patterns/matrix
- title: Media object
url: /docs/patterns/media-object
- title: Modal
url: /docs/patterns/modal
- title: Muted heading
url: /docs/patterns/muted-heading
- title: Navigation
url: /docs/patterns/navigation
- title: Notifications
url: /docs/patterns/notification
- title: Pagination
url: /docs/patterns/pagination
- title: Quotes
url: /docs/patterns/pull-quote
- title: Rule
url: /docs/patterns/rule
- title: Search and filter
url: /docs/patterns/search-and-filter
- title: Search box
url: /docs/patterns/search-box
- title: Sections
url: /docs/patterns/section
- title: Segmented control
url: /docs/patterns/segmented-control
- title: Slider
url: /docs/patterns/slider
- title: Status labels
url: /docs/patterns/status-labels
- title: Strip
url: /docs/patterns/strip
- title: Suru
url: /docs/patterns/suru
- title: Switch
url: /docs/patterns/switch
- title: Table of contents
url: /docs/patterns/table-of-contents
- title: Tabs
url: /docs/patterns/tabs
- title: Tooltips
url: /docs/patterns/tooltips
ordering: alphabetical
items:
- title: Accordion
url: /docs/patterns/accordion
- title: Equal height row
url: /docs/patterns/equal-height-row
- title: Badge
url: /docs/patterns/badge
- title: Breadcrumbs
url: /docs/patterns/breadcrumbs
- title: Buttons
url: /docs/patterns/buttons
- title: Cards
url: /docs/patterns/card
- title: Chips
url: /docs/patterns/chip
- title: Contextual menu
url: /docs/patterns/contextual-menu
- title: Divider
url: /docs/patterns/divider
- title: Empty state
url: /docs/patterns/empty-state
- title: Grid
url: /docs/patterns/grid
- title: Heading icon
url: /docs/patterns/heading-icon
- title: Icons
url: /docs/patterns/icons
- title: Images
url: /docs/patterns/images
- title: Links
url: /docs/patterns/links
- title: List tree
url: /docs/patterns/list-tree
- title: Lists
url: /docs/patterns/lists
- title: Logo section
url: /docs/patterns/logo-section
- title: Matrix
url: /docs/patterns/matrix
- title: Media object
url: /docs/patterns/media-object
- title: Modal
url: /docs/patterns/modal
- title: Muted heading
url: /docs/patterns/muted-heading
- title: Navigation
url: /docs/patterns/navigation
- title: Notifications
url: /docs/patterns/notification
- title: Pagination
url: /docs/patterns/pagination
- title: Quotes
url: /docs/patterns/pull-quote
- title: Rule
url: /docs/patterns/rule
- title: Search and filter
url: /docs/patterns/search-and-filter
- title: Search box
url: /docs/patterns/search-box
- title: Sections
url: /docs/patterns/section
- title: Segmented control
url: /docs/patterns/segmented-control
- title: Slider
url: /docs/patterns/slider
- title: Status labels
url: /docs/patterns/status-labels
- title: Strip
url: /docs/patterns/strip
- title: Suru
url: /docs/patterns/suru
- title: Switch
url: /docs/patterns/switch
- title: Table of contents
url: /docs/patterns/table-of-contents
- title: Tabs
url: /docs/patterns/tabs
- title: Tooltips
url: /docs/patterns/tooltips
- heading: Utilities
subheadings:
- title: Align
url: /docs/utilities/align
- title: Baseline grid
url: /docs/utilities/baseline-grid
- title: Clearfix
url: /docs/utilities/clearfix
- title: Embedded media
url: /docs/utilities/embedded-media
- title: Equal height
url: /docs/utilities/equal-height
- title: Floats
url: /docs/utilities/floats
- title: Font metrics
url: /docs/utilities/font-metrics
- title: Functions
url: /docs/utilities/functions
- title: Hide
url: /docs/utilities/hide
- title: Image position
url: /docs/utilities/image-position
- title: Margin collapse
url: /docs/utilities/margin-collapse
- title: No print
url: /docs/utilities/no-print
- title: Off-screen
url: /docs/utilities/off-screen
- title: Padding collapse
url: /docs/utilities/padding-collapse
- title: Table cell padding overlap
url: /docs/utilities/table-cell-padding-overlap
- title: Text max width
url: /docs/utilities/text-max-width
- title: Text with icon
url: /docs/utilities/has-icon
- title: Truncation
url: /docs/utilities/truncate
- title: Show
url: /docs/utilities/show
- title: Vertical spacing
url: /docs/utilities/vertical-spacing
- title: Vertically center
url: /docs/utilities/vertically-center
ordering: alphabetical
items:
- title: Align
url: /docs/utilities/align
- title: Baseline grid
url: /docs/utilities/baseline-grid
- title: Clearfix
url: /docs/utilities/clearfix
- title: Embedded media
url: /docs/utilities/embedded-media
- title: Equal height
url: /docs/utilities/equal-height
- title: Floats
url: /docs/utilities/floats
- title: Font metrics
url: /docs/utilities/font-metrics
- title: Functions
url: /docs/utilities/functions
- title: Hide
url: /docs/utilities/hide
- title: Image position
url: /docs/utilities/image-position
- title: Margin collapse
url: /docs/utilities/margin-collapse
- title: No print
url: /docs/utilities/no-print
- title: Off-screen
url: /docs/utilities/off-screen
- title: Padding collapse
url: /docs/utilities/padding-collapse
- title: Table cell padding overlap
url: /docs/utilities/table-cell-padding-overlap
- title: Text max width
url: /docs/utilities/text-max-width
- title: Text with icon
url: /docs/utilities/has-icon
- title: Truncation
url: /docs/utilities/truncate
- title: Show
url: /docs/utilities/show
- title: Vertical spacing
url: /docs/utilities/vertical-spacing
- title: Vertically center
url: /docs/utilities/vertically-center
- heading: Layouts
subheadings:
- title: Application
url: /docs/layouts/application
- title: Brochure site
url: /docs/layouts/brochure
- title: Documentation
url: /docs/layouts/documentation
- title: Fluid breakout
url: /docs/layouts/fluid-breakout
- title: Full-width
url: /docs/layouts/full-width
- title: Sticky footer
url: /docs/layouts/sticky-footer
ordering: alphabetical
items:
- title: Application
url: /docs/layouts/application
- title: Brochure site
url: /docs/layouts/brochure
- title: Documentation
url: /docs/layouts/documentation
- title: Fluid breakout
url: /docs/layouts/fluid-breakout
- title: Full-width
url: /docs/layouts/full-width
- title: Sticky footer
url: /docs/layouts/sticky-footer
- heading: Settings
subheadings:
- title: Animations
url: /docs/settings/animation-settings
- title: Assets
url: /docs/settings/assets-settings
- title: Breakpoints
url: /docs/settings/breakpoint-settings
- title: Color
url: /docs/settings/color-settings
- title: Font
url: /docs/settings/font-settings
- title: Layout
url: /docs/settings/layout-settings
- title: Placeholders
url: /docs/settings/placeholder-settings
- title: Spacing
url: /docs/settings/spacing-settings
- title: Table layout
url: /docs/settings/table-layout
ordering: alphabetical
items:
- title: Animations
url: /docs/settings/animation-settings
- title: Assets
url: /docs/settings/assets-settings
- title: Breakpoints
url: /docs/settings/breakpoint-settings
- title: Color
url: /docs/settings/color-settings
- title: Font
url: /docs/settings/font-settings
- title: Layout
url: /docs/settings/layout-settings
- title: Placeholders
url: /docs/settings/placeholder-settings
- title: Spacing
url: /docs/settings/spacing-settings
- title: Table layout
url: /docs/settings/table-layout
- heading: Resources
subheadings:
- title: Component examples
url: /docs/examples
- title: Release notes for {version}
url: https://github.com/canonical/vanilla-framework/releases/latest
- title: Download Sketch UI Kit
url: https://assets.ubuntu.com/latest-redirects/vanilla-framework.sketch
ordering: alphabetical
items:
- title: Component examples
url: /docs/examples
- title: Release notes for {version}
url: https://github.com/canonical/vanilla-framework/releases/latest
- title: Download Sketch UI Kit
url: https://assets.ubuntu.com/latest-redirects/vanilla-framework.sketch
2 changes: 1 addition & 1 deletion templates/_layouts/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<li class="p-side-navigation__item">
<button class="p-side-navigation__accordion-button" aria-expanded="false">{{ item.heading | replace("{version}", version) }}</button>
<ul class="p-side-navigation__list">
{% for subheading in item.subheadings %}
{% for subheading in item.subheadings['items'] %}
{{ side_nav_item(subheading.url, subheading.title) }}
{% endfor %}
</ul>
Expand Down