Wiki → Syntax

This page documents the supported syntax in this wiki.

Feel free to try out syntax in Sandbox page.

Callouts

:::info
This is an info box
:::

:::warning
This is a warning box
:::

:::tip
This is a tip box
:::

:::danger[BE CAREFUL]
This is a danger box
:::

INFO

This is an info box

WARNING

This is a warning box

TIP

This is a tip box

BE CAREFUL

This is a danger box


Details block

Details blocks are useful for auxiliary information, esp. FAQ sections. They are rendered as a collapsible section.

:::details[Summary here]
Details here
:::
Summary here

Details here


Draft block

Draft blocks are useful for marking a piece of content as draft.

:::Draft
1x projector, 1x hdmi tx, 2x wireless mic, 1x mic rx, 1x mixer, 1x speaker, stereo
:::
draft

1x projector, 1x hdmi tx, 2x wireless mic, 1x mic rx, 1x mixer, 1x speaker, stereo


Icon

You can add any icon supported by Iconify by using the :Icon syntax:

:Icon{icon=material-symbols:train-outline}


Liquid

You can use Liquid tags and filters to add rudimentary logic to a wiki page.

{% assign showdownSpaceEvents = '{"match":{"event.hosts":"showdown.space"}}' | query_pages %}
{% render 'PageList', pages: showdownSpaceEvents %}

Variables

These variables can be used in Liquid tags.

VariableDescription
refThe current page filename, e.g. Syntax.
pageData in frontmatter.

WARNING

These variables can only be used in a page, and cannot be used in templates. To use in a template, they have to be explicitly passed in.

Filters

These filters can be used to query data from pages in a wiki.

FiltersDescription
get_pageLooks up the front-matter data from another page. Input is a page reference. Output is a page object with these properties: ref, exists, data
get_subpagesQueries for pages inside another page’s namespace. Input is a page reference. For example, if input is Feedback, then this filter will query pages with ref beginning with Feedback/. Output is an array of page objects.
query_pagesQueries for pages matching a criteria. Input is a JSON string describing the search query. Output is an array of page objects.

Message

Messages are useful for discussing in the wiki. This helps facilitate the Thread Mode in a wiki.

::Message[**"this"** is a message]{from=person1}

:::Message{from=@dtinth}
this is another message \
that spans multiple lines \
also, when the `from=` attribute starts with an `@`, it is treated as GitHub username
:::
person1
"this" is a message
—person1
@dtinth

this is another message
that spans multiple lines
also, when the from= attribute starts with an @, it is treated as GitHub username

—@dtinth

Template

Template lets you re-use content across multiple pages without having to duplicate content. A template is a page inside the Template namespace. To render a template, use the {% render %} Liquid syntax and specify the name of the template. For a list of available template, see Template.

Event

Renders a link to the event.

{% render 'Event', name: 'creativecodingmeetup' %}

Creative Coding Meetup

EventBox

Renders a box for pages related to the event.

{% render 'EventBox', name: 'creativecodingmeetup' %}

Facebook

Renders a link to a Facebook profile with an icon.

{% render 'Facebook', user: 'creatorsgarten' %}

@creatorsgarten

Page name can be specified:

{% render 'Facebook', user: 'creatorsgarten', name: 'Creatorsgarten' %}

Creatorsgarten

GitHub

Renders a link to a GitHub user or GitHub repo with an icon.

{% render 'GitHub', user: 'creatorsgarten' %}

@creatorsgarten

{% render 'GitHub', repo: 'creatorsgarten/wiki' %}

creatorsgarten/wiki

Grtn

Renders a Grtn shortcut link.

{% render 'Grtn', path: 'e' %}

[grtn.org/e]

Instagram

Renders a link to a Instagram profile with an icon.

{% render 'Instagram', user: 'creatorsgarten' %}

@creatorsgarten

YouTube

Renders a link to a YouTube channel with an icon.

{% render 'YouTube', user: 'creatorsgarten' %}

@creatorsgarten

WikiLinks

Use the double bracket notation to create links to wiki pages.

- [[Inventory]]
- [[Special/RecentChanges|Recent changes]]

Metadata

UPDATED 11 July 2024
HISTORY GitHub