Cheatsheet

Updated: 4 Mar 2025

Styling Text #

We can do text in **bold** or in _italics_.

We can do text in bold or in italics.

Hints/Alerts #

Hint shortcode can be used as hint/alerts/notification block.
There are 3 colours to choose: info, warning and danger.

{{< hint [info|warning|danger] >}}
**Markdown content**  
{{< /hint >}}

Markdown content

Markdown content

Markdown content

H2 Header #

## H2 Header

H2 This is the title we use for section headers. Don’t use H1 as that is reserved for the page title.

H3 Header #

### H3 Header

We use this header for sub-sections.

Link - Inline #

[I'm an inline-style link](https://www.google.com)

I’m an inline-style link

Link - Button #

{{< button href="img/imageA.jpg" >}}Download{{< /button >}}

Images #

Simple #

![Description](img/imageA.jpg)

With Title #

{{< figure src="img/imageA.jpg" title="Example Title" >}}

With Title & Caption #

{{< figure src="img/imageA.jpg" title="Example Title" caption="This is my caption that can be a bit longer." >}}

Image Comparison #

Ensure you put the filenames in quote marks so that the forward slash is handled.

Compare with no captions #

{{< imageCompare "img/imageA.jpg" "img/imageB.jpg" >}}

Compare with captions #

{{< imageCompare "img/imageA.jpg" "img/imageB.jpg" "Image A" "Image B" >}}

Lists #

Unordered Lists #

* This is bullets
* This is another bullet
* And another

• This is bullets
• This is another bullet
• And another

Ordered Lists #

1. This is bullets
1. This is another bullet
1. And another

1. This is bullets
2. This is another bullet
3. And another

Tables #

| Column A | Column B |
| --- | --- |
| ABC | DEF |

Columns #

Columns help organize shorter pieces of content horizontally for readability.

{{< columns >}} <!-- begin columns block -->

<--->

<--->


{{< /columns >}}

Custom Columns #

Custom columns allow you to specify the relative width of a two column set up. This is useful for when you want to have a narrower image column next to a larger text column.

{{< customColumns [one|two|three|four|five|six] [one|two|three|four|five|six] >}} 
<!-- First column content -->
<--->
<!-- Second column content -->
{{< /customColumns >}}

Integer suscipit interdum metus ac elementum. Donec ut diam in velit hendrerit rutrum. In est justo, gravida ut massa sed, tempor tincidunt urna. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc venenatis in lorem nec commodo. Vestibulum vulputate faucibus libero, vitae cursus sem auctor vitae. In laoreet aliquam sapien, sed suscipit eros tempus eu. Vestibulum suscipit sapien vestibulum justo bibendum, mattis semper nibh lobortis. Aenean sodales orci ut tortor molestie vestibulum. Vivamus in iaculis nisl. Proin sit amet lacinia lectus. Praesent placerat, elit eu sodales tristique.

Tabs #

Tabs let you organize content by context, for example installation instructions for each supported platform.

{{< tabs "uniqueid" >}}
{{< tab "MacOS" >}} # MacOS Content {{< /tab >}}
{{< tab "Linux" >}} # Linux Content {{< /tab >}}
{{< tab "Windows" >}} # Windows Content {{< /tab >}}
{{< /tabs >}}

FAQs #

FAQs are a great way to answer common questions and allow for deep linking to a specific question. Deep links are generated from the question title automatically.

{{< faq "What is the meaning of life?" >}}
42
{{< /faq >}}

Videos #

Related Videos (YouTube) #

Related videos are shown in the right hand column.

This should be the primary method of adding videos to pages.

You add them in the Frontmatter using the YouTube video ID. Only YouTube is supported at the moment.

related_videos:
- lLrQ83h2GTE
- OUng4stVL1o

YouTube #

{{< youtube OUng4stVL1o >}}

Vimeo #

{{< vimeo 146022717 >}}

Video Files #

This loads local video files, hosted in the site.

There are three params:

• video src [src]
• video poster (holder image while loading) [poster] <– can just be ""
• autoplay & loop [autoplay]

{{<video "sample.mp4" "sample.jpg" true >}}
{{<video src="sample.mp4" poster="sample.jpg" autoplay=true >}}

Code #

JavaScript File #

{{< jsCode example.js >}}

Reads a file .js in the pages asset directory and renders it with a Copy-JS button.

function Update()  { 
    t = UpdateContext.LocalTime;
    numLayers = Document.GetNumLayers();  
    layer = Document.GetLayer(0);
    layerEndTime = layer.GetEndTime();
    
    rssNode = layer.FindNode("RSSFeed").AsRSSFeedNode();
    textNode = layer.FindNode("MainText");
    imageLoaderNode = layer.FindNode("MainImageLoader");

    numRssEntries = rssNode.GetNumEntries();
    entryIndex = 0;

    entryImageFilename = rssNode.GetEntryImageFilename(entryIndex, 0);
    entryText =  rssNode.GetEntryTitle(entryIndex);

    imageLoaderNode.SetString("Attributes.Filename", entryImageFilename);
    textNode.SetText(entryText);
}

JavaScript Syntax #

Used only on JavaScript reference pages. Renders the JavaScript function syntax from the Front Matter including the function declaration and parameter descriptions.

{{< jsSyntax >}}

string myDummyFunction(int entryIndex, int imageIndex);

Parameters

.FX Shader File #

{{< fxCode example.fx >}}

Reads a file .fx in the pages asset directory and renders it with a Download & Copy-FX button.

Texture2D <float4> InputBuffer : INPUTBUFFER;			// The input texture

float CurrentTime : CURRENTTIME;						// The current time
float BlendAmount : BLENDAMOUNT;						// The blend amount param

float MyCustomParameter;								// A custom parameter

sampler LinearClampSampler
{
	Filter = Min_Mag_Linear_Mip_Point;
    AddressU = Clamp;
    AddressV = Clamp;
    AddressW = Clamp;
};

struct VS_OUTPUT
{
    float4 Position  : SV_POSITION;
	float2 Uv : TEXCOORD0;
};

Section Galleries/Lists #

Sections often need to list their child pages. We have two shortcodes that enable this:

{{< sectionThumb >}}
{{< sectionNoThumb >}}

Front Matter #

Generic (All Pages) #

title: Probe Grid
description: Generates a grid of light probes for probe lighting.
weight: 1
legacy_slug: nodes-lighting-probe-grid
img_thumbnail: img/node-lighting-probe-grid-vis-img.jpg
related_videos:
- lLrQ83h2GTE
- OUng4stVL1o

draft: false
bookToc: true
bookHidden: false
bookCollapseSection: false
bookComments: false
bookSearchExclude: false

Sections Only #

bookCollapseSection: false
bookFlatSection: false

Node Pages #

node:
  example_dfx: myfile.dfx
  example_snippet: mysnippet.xml
  img_examples:
   - img/node-lighting-probe-grid-vis-img.jpg
  img_examples_compare: 
   - imageA.jpg
   - imageB.jpg
  img_nodegraph: img/node-lighting-probe-grid-ng.jpg
  previousNames: 
   - Old Node
uuid: 848EAC41-3B52-46BE-BD85-4321B6076852