-
Notifications
You must be signed in to change notification settings - Fork 394
Closed
Labels
documentationDoc improvements & quarto-webDoc improvements & quarto-web
Milestone
Description
A list of things from the changelog that I think need a mention in the Guide (or other appropriate section of quarto.org) and aren't already in the 1.4 Highlights.
As of commit 53fca91 78023ec 536f607
Breaking Changes
- In website projects, a single sidebar with a
idproperty will no longer be used as a global sidebar. It will instead be used as a sidebar for only pages which specify thatidor pages linked to from the sidebar.
HTML Format
- Add support for showing cross reference contents on hover (use
crossrefs-hover: falseto disable). - Add support for displaying
keywordsin HTML page title block, when present. - (#3473): Add support for
body-rightandbody-leftlayouts for Website Table of Contents. -
(#4840): Add support for specifying a custom Hypothesis client url usingNo change beyond fixing link to ref page where this option is documented.client-url -
(#4882): Add support forcanonical-url, which when provided will include a link tag with rel='canonical' which will use an explictly provided or automatically generated canonical url for the document. - (#7187): Add
html-table-processing: noneto document- and project-level metadata to disable HTML table processing. Add{html-table-processing="none"}to a fenced div to disable HTML table processing for the elements in that div. Addhtml-table-processing: noneon knitr or jupyter cell to disable HTML table processing for the cell output content.
RevealJS Format
- (#1943): Allow setting
code-block-heightin presentation front matter. - (#7134):
.nostrechcan now be applied on image directly to opt-out Revealjs' image stretching whenauto-stretch: true(the default).
PDF Format
- (#5058): Add a
before-title.texpartial to the PDF format. This partial will appear in the document premable just before the title block, allowing further customization of the document preamble. By default, this partial is empty.
Website Listings
- Add support for programmatically filtering content from a listing using
includeorexcludewith glob syntax to include or exclude specific items from the listing. See d415d9ca5b7cb59a8a4750dd3eeb60116b931bd6s - (#6407): Add supporting for the field
word-countfor listing items. It is not displayed by default. -
(#4800): Add support for including anMake sure it's in reference.xml-stylesheetin listings. Use thexml-stylesheet: example.xslunderfeed:to provide a path to an XSL style sheet to style your RSS feed. - (#7290): Add support for
feed:typeofmetadata, which will use only explicitly provided description metadata when generating an RSS feed. Additionally, note thatpartialfeed types will prefer to use an explicit description over the first paragraph, when a description is available. Add entry in table in Guide, check its in Reference
Websites
- Add support for
navbar > toggle-positionto control whether the responsive navbar toggle appears on the right or the left. - Add support for setting
page-navigation: true|falsein either a page or in_metadata.yml. This allows individual pages or sections of a website to control whetherpage-navigaationappears. - Add support for
bread-crumbs: true|falseto control whether bread crumbs are displayed. Add support for display of breadcrumbs on full width (non-mobile) pages whenbread-crumbsis true. Default value is true. - (#5283): Add support for setting
repo-actions: falsein a document to prevent the display of repository actions on a specific page. - (#5964): Add support for
repo-link-targetandrepo-link-relto control the corresponding attributes of repo-action links. - Add support for
show-item-contextkey within thesearchkey to control whether page parents are display next to items in search results. Passtree,parent,root, or boolean (if you pass true,treeis the default). - (#5763): Add support for a keyboard shortcut to launch search (defaults to
s,for/). Usesearch>keyboard-shortcutto override with your own key(s). - (#7796): Allow providing placeholder text using the language key
search-text-placeholder - (#5389): Allow a website project to provide a default image used in social metadata tags.
- (#5251): Allow individual pages to specify
image: falseto prevent image discover for Twitter and Open Graph metadata. - (#5624): Add support for localized Cookie Consent (using either the document's language or by specifying the language explicitly under the cookie consent key).
Website Search
Jupyter
- Added
ipynb-shell-interactivityoption (enables specification of IPythonInteractiveShell.ast_node_interactivityoption) - Support for
plotly-connectedoption to determine where Plotly is embedded or loaded from CDN
Author and Affiliations
- (#5764): Add support for affiliations to include a
groupproperty to represent the team or research group within the affiliation - (#6138): Add support for
degreesto specify academic titles or professional certifications displayed following a personal name (for example, "MD", "PhD").
Lua filters
- Add support for relative paths in
require()calls. - Add support
quarto.doc.add_resourceandquarto.doc.add_supporting.add_resourcewill add a resource file to the current render, copying that file to the same relative location in the output directory.add_supportingwill add a supporting file to the current render, moving that file file to the same relative location in the output directory. -
(#5242): Add line numbers to error messages. -
(#5461): ensure return type ofstripTrailingSpaceis alwayspandoc.List. -
(#5466): Provide global environment_Gto user filters. -
(#6211): Improve error message when a JSON filter (or a potentially misspelled Lua filter from an extension) is not found. - (#6215): Add
quarto.utils.string_to_inlinesandquarto.utils.string_to_blocksto Lua API to convert a string to a list of inlines or blocks taking into account quarto's AST structure. -
(#6289): allowmarkdownToInlinesto take empty string. - (#6935): Add isGithubMarkdownOutput() to quarto.format API.
- (#6935): render callouts to
gfmusing GitHub's syntax. - (#7083): Separate custom node handlers for Span and Div nodes, enabling conditional content spans (author: @knuesel)
Other Fixes and Improvements
-
Support--output-dirfor rendering individual files. - (#1237): Allow
includeshortcodes to be resolved from inside non-executable code cells and metadata blocks. - (#4820): Add support for setting the Giscus light/dark themes.
- (#5755): Allow document metadata to control conditional content.
- (#8086): Add support for indexing array metadata in
metashortcode. - (#1173): Allow specifying margin caption location on a per cell basis
Metadata
Metadata
Assignees
Labels
documentationDoc improvements & quarto-webDoc improvements & quarto-web