cn:articles directive¶
A listing directive that can be used to show a list of articles from a specific venue, collection or kind.
- Options
- venue (string, required)
The venue to list articles from.
- collection (string)
The collection to list articles from.
- status (string)
The status of articles to list (published | in-review).
- submission-kind (string)
The kind of articles to list.
- layout (string)
The layout of the of articles (list | cards).
- wide (boolean)
If set, the listing will be wide.
- limit (number)
The maximum number of articles to list.
- pagination (string)
If
limitis set, this gives a hint to the renderer on how to handle pagination (more | all | scroll).- show-collection (boolean)
If set to true, the listing will show the collection name.
- show-kind (boolean)
If set to true, the listing will show the kind name.
- show-date (boolean)
If set to true, the listing will not show the publication date.
- show-thumbnails (boolean)
If set to true, the listing will not show thumbnails.
- show-count (boolean)
If set to true, the total number of items in the listing will be shown.
cn:collections directive¶
Create a listing of all collections available in the venue.
- Options
- venue (string, required)
The venue to list collections from.
- filter (string)
The status of collections to list (open | closed | all).
- exclude (string)
Collections to ignore, by name and comma separated.
- show-count (boolean)
If set to true, the number of items in the collection will be shown.
person directive¶
An configurable site footer with a logo, tagline, and links.
- Directive Body (parsed)
A bio or more information about the person.
- Options
- name (string)
URL of the logo
- position (string)
Person’s role or position
- pronouns (string)
Person’s pronouns
- description (parsed)
Short description to show in the card
- github (string)
Github Username
- twitter (string)
Twitter Username
- linkedin (string)
LinkedIn Username
- orcid (string)
ORCID identifier, e.g.
0000-0000-0000-0000- website (string)
URL of a website
- email (string)
Email address
- image (string)
Image for a file
- open (boolean)
Start with the card open
- reverse (boolean)
Put the image on the right
card:blog directive¶
A card that is great for a blog post, showing a thumbnail, date and tags
- Directive Argument (parsed)
Title of the blog post
- Directive Body (parsed)
Blog card description
- Options
- url (string)
Link to the blog post
- Alias:
link - image (string)
Image for a file
- date (string)
URL of the logo
Comma separated tags
template:list directive¶
Load a YAML file and generate a list of templated content
- Directive Argument (string)
Path to the YAML file
- Directive Body (string)
A Nunjucks template to render each link.
- Options
- path (string)
The part of the loaded content that you are going to load
- parent (string)
The parent ast type or “none”
- offset (number)
The number of items to show from the array
- limit (number)
The number of items to show from the array
- first (string)
A myst string or data to show at the start of the list
- last (string)
A myst string or data to show at the end of the list
