Skip to content

Commit 1f68190

Browse files
authored
Fixes for leftover v1.8 documentation issues (#1946)
* fix quarto-cli/issues/10084 * fix quarto-dev/quarto-cli/issues/10565 * fix for quarto-cli/issues/13162 * fix for quarto-cli/issues/13295
1 parent a6d7c97 commit 1f68190

4 files changed

Lines changed: 36 additions & 7 deletions

File tree

docs/authoring/includes.qmd

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,6 @@ A couple of important things to remember when using computational includes:
104104

105105
2) Computational includes work only in `.qmd` files (they don't work in `.ipynb` notebook files)
106106

107-
Note that you can't use the `include` shortcode within a computational code block itself - as the example above shows, the executable code block needs to be inside the included document.
108-
109107
```{=html}
110108
<style type="text/css">
111109
code span.in {

docs/authoring/tables.qmd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -773,6 +773,16 @@ Note that grid tables are quite awkward to write with a plain text editor (becau
773773
- Quarto [Visual Editor](/docs/visual-editor/content.qmd#editing-tables)
774774
- Tables Generator's [Plain Text mode](https://www.tablesgenerator.com/text_tables) with `Use reStructuredText syntax` enabled
775775

776+
::: callout-warning
777+
778+
## Shortcodes are not supported
779+
780+
In Quarto, shortcodes are processed internally by transforming the Markdown text ahead of Pandoc.
781+
Unfortunately, it's not possible to do this transformation in a way that preserves the grid table structure.
782+
As a result, shortcodes are not supported inside grid tables. Consider using [list tables](#list-tables) instead.
783+
784+
:::
785+
776786
## HTML Tables
777787

778788
Quarto can process HTML tables in `html` `RawBlock` nodes (_i.e._, `{=html}`) and convert them to Markdown tables, regardless of the output format (intentionally including non-HTML formats).

docs/extensions/distributing.qmd

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,27 @@ Here are all of the fields that can be specified in the `_extension.yml` file:
8383
`formats`
8484

8585
: A record containing the key value pairs of output formats and the metadata associated with that output format.
86+
87+
`project`
88+
89+
: Information about a [custom Quarto project type](./project-types.qmd).
90+
91+
`revealjs-plugins`
92+
93+
: Information about a [RevealJS plugin](./revealjs.qmd).
94+
95+
`metadata`
96+
97+
: [Metadata](./metadata.qmd) to be merged into the Quarto project using the extension.
98+
99+
`brand`
100+
101+
: Information about a [brand extension](./brand.qmd).
102+
103+
`engine`
104+
105+
: Information about a [custom engine](./engine.qmd).
106+
86107
:::
87108

88109
:::{.callout-note}

docs/extensions/filters.qmd

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,28 +27,28 @@ You can write Pandoc filters using Lua (via Pandoc's built-in Lua interpreter) o
2727

2828
## Activating Filters
2929

30-
If you've developed a filter and want to use it within a document you need to add it to the list of `filters` for the document. For example, here we arrange for the [spellcheck](https://github.com/pandoc/lua-filters/tree/master/spellcheck) filter to run:
30+
If you've developed a filter and want to use it within a document you need to add it to the list of `filters` for the document. For example, here we arrange for the [lilypond](https://github.com/pandoc/lua-filters/tree/master/lilypond) music-engraving filter to run:
3131

3232
``` yaml
3333
---
3434
filters:
35-
- spellcheck.lua
35+
- lilypond.lua
3636
---
3737
```
3838

39-
By default, user filters are run before Quarto's built-in filters. For some filters you'll want to modify this behavior. For example, here we arrange to run `spellcheck` before Quarto's filters and `fontawesome` after:
39+
By default, user filters are run before Quarto's built-in filters. For some filters you'll want to modify this behavior. For example, here we arrange to run `lilypond` before Quarto's filters and `fontawesome` after:
4040

4141
``` yaml
4242
filters:
43-
- spellcheck.lua
43+
- lilypond.lua
4444
- quarto
4545
- fontawesome
4646
```
4747
4848
Beyond a running filters before or after Quarto's filters, you can also
4949
precisely target the location in the AST processing. Read more in [Targeting of AST Processing Phases](/docs/advanced/quarto-ast.qmd#targeting-of-ast-processing-phases).
5050
51-
You'll notice that one of the extensions (`spellcheck.lua`) has a file extension and the other (`fontawesome`) does not. This difference stems from how the extensions are distributed: an extension distributed as a plain Lua file uses `.lua` whereas a filter distributed as a [Quarto Extension](index.qmd) does not. The next section explores how to create filters as extensions.
51+
You'll notice that one of the extensions (`lilypond.lua`) has a file extension and the other (`fontawesome`) does not. This difference stems from how the extensions are distributed: an extension distributed as a plain Lua file uses `.lua` whereas a filter distributed as a [Quarto Extension](index.qmd) does not. The next section explores how to create filters as extensions.
5252

5353

5454
## Filter Extensions

0 commit comments

Comments
 (0)