Skip to content

Commit 17658c4

Browse files
committed
docs: add note about gallery listing example
1 parent fdbf1f6 commit 17658c4

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/websites/website-listings-custom.qmd

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,13 +132,17 @@ where the contents of `items.yml` is:
132132
Portions of this website are built using custom listings. The best place to start is with [our gallery](/docs/gallery/index.qmd), which is a listing built using a custom template and a metadata file. You can view the source code used to create the gallery page in our [Github repository](https://github.com/quarto-dev/quarto-web).
133133

134134
| File | Description |
135-
|-------------------------------------|-----------------------------------|
135+
|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
136136
| [gallery.yml](https://github.com/quarto-dev/quarto-web/blob/main/docs/gallery/gallery.yml) | The metadata that controls what items are displayed in the gallery listing. |
137137
| [gallery.ejs](https://github.com/quarto-dev/quarto-web/blob/main/docs/gallery/gallery.ejs) | The template used to display the items on the page. |
138138
| [index.qmd](https://github.com/quarto-dev/quarto-web/blob/main/docs/gallery/index.qmd) | The Quarto document that configures and positions the listing in the `#gallery` div. |
139139

140140
: {tbl-colwidths="\[30,70\]"}
141141

142+
::: {.callout-note}
143+
Note that the `gallery.ejs` template does not allow its content to be read as Markdown.
144+
:::
145+
142146
## Sorting, Filtering, and Pagination
143147

144148
By default, sorting, filtering, and pagination are disabled for custom listings templates, but with some simple changes to your template and listing options, you can add this capability to your custom listing. To do this, you need to include the following three things in your custom template:

0 commit comments

Comments
 (0)