docs(schema): note markdown support in website navigation text fields#14503
Merged
Conversation
The `text` field for navbar/sidebar navigation items supports inline markdown formatting, processed through the markdown pipeline in website-navigation-md.ts. The schema description didn't say so. Fixes #6858
…r fields Several website navigation fields run through the markdown pipeline in website-navigation-md.ts but their schema descriptions did not say so: navbar/sidebar titles (navbarTitleHandler/sidebarTitleHandler), announcement content (announcementHandler), and page-footer left/center/ right regions (footerHandler). Refs #6858
Collaborator
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
cderv
added a commit
to quarto-dev/quarto-web
that referenced
this pull request
May 11, 2026
Regenerated via _tools/reference.ts against quarto-cli main with quarto-dev/quarto-cli#14503. Picks up the new "Supports markdown formatting." note on navigation-item.text, navbar.title, sidebar.title, announcement.content, and page-footer left/center/right.
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.
Description
Several website navigation fields are markdown-processed through
website-navigation-md.tsbut their schema descriptions did not say so.Updated descriptions to note markdown support:
navigation-item.text— covers navbar items, sidebar items, footer items, breadcrumbs, and page-navigation prev/next labelsnavbar.title,sidebar.titleannouncement.contentpage-footer.left/center/rightSchema source is
src/resources/schema/definitions.yml; the other touched files are regenerated artifacts fromdev-call build-artifacts.Follow-up #14502 tracks consolidating these repeated field specs into reusable schema fragments.
Fixes #6858
Checklist
I have (if applicable):