by Dan Rigdon-Bel (Last updated: Monday, October 7, 2024)

Below are examples of nearly all the available syntax using Markdown, the table-of-contents UI widget, etc.

Conventions

Site file naming

The naming convention for files - guides, samples, etc - is lowercase with - used as spaces. This leads to more consistent and legible URLs. In addition, Google recommends one construct compound URL names with - and not underbars (_). For example, consider the name of this guide: “Style Guide”. The file name for this guide is developer-docs-style-guide. Google treats a hyphen as a word separator, but does not treat an underscore that way. Google treats and underscore as a word joiner — so “red_sneakers” is the same as “redsneakers.”

In general, when considering new file names for guides, please imagine you are saying “Guide to _____”. This often leads to verbs ending in “-ing”, the progressive or continuous verb tense. Obviously, this is not a hard-and-fast rule, but rather a convention.

In general, when considering new file names for samples, please imagine you are saying “_____ sample”. As with guides, this is not a hard-and-fast rule, but rather a general convention.

Division of content

# Title become H1 headers and are reserved for the title of the page only.

## Header become H2 headers and are reserved for major sections within the page.

### Sub Header become H3 headers and are reserved for sub-sections within a major section.

Fonts

On Windows, this site attempts to use Segoe UI (font size: 16 px, font weight: 400, line height: 1.6) and falls back to Frutiger Linotype, Dejavu Sans, Helvetica Neue, Helvetica, Arial, in that order. On macOS, the site will (almost) certainly use Helvetica Neue or Helvetica (font size: 16 px, font weight: 300, line height: 1.6). The operating system-specific font weight is set in the footer using javascript.

Paths & Filenames

*Italics* are used to denote filenames, paths, and file extensions. For example:

Navigate to C:\Program Files\Rhinoceros 5 (64-bit)\Plug-ins.

Bold

**Bold** (strong emphasis) is used in instructions to highlight critical instructions that are very important. Bold should be used sparingly as it is often present in headers as natural division of content.

Spelling & Case

The following spelling and case conventions are adopted on this site:

• “Plugins” is not hyphenated unless it refers to a place in the Rhino UI where it is hyphenated.
• “openNURBS” (not OpenNURBS, nor opennurbs, nor oPeNnURBs) unless it refers to a namespace in code where it is capitalized, or a path where it is not.

Images & Screenshots

Please use image names without spaces (use a hypen - NOT an underscore - for word separation). It is also safest to use lowercase filenames and extensions.

When feasible, it is best to use the .svg vector format for images, especially for diagrams.

When using bitmap images, the preferred format is .png, but any browser-friendly bitmap format will work.

When capturing screenshots, consider that many people have high-DPI (aka: “Retina”) displays. Please capture all screenshots on a high-DPI display.

See the Text Modifiers > Images section of this guide for more information on inserting images.

Headers

Headers demarcate major sections of the page, guide, etc.

Headers are created like this:

The example above is an H2 header.

Creating a header automatically creates an #anchor tag in the generated html.

For headers with multiple words, the markdown parser lowercases all the words, removes non-alphanumeric characters and adds dashes for spaces. For example, if we had a header like this:

the resulting html anchor tag would be:

Read more about anchors here.

Sub Headers

Sub Headers demarcate sub-sections a major section underneath a header.

Sub Headers are created like this:

The example above is an H3 header, which we are calling a “Sub Header.”

Just like with H2 headers, H3 headers also create an #anchor tag in the generated html.

Heading Anchors

Anchors are auto generated from heading texts. They’re formatted to be URL safe. In cases that it’s really needed, an additional anchor tag can be specified.

Formatting

In the process of sanitizing the heading text to generate anchors, all characters will be lowercased. Spaces will be replaced by - and special character will be removed.

For example a heading reading:

becomes:

Optional Explicit Anchors

Optionally, an additional anchor with explicit ID can be specified using anchor shortcode (does not replace auto generated heading anchors). This can be useful for making sure lagacy links to headings work when migrating from another existing system to Hugo.

For example below heading in markdown:

Will generate two anchors:

and

Table of Contents

The UI-widget to the left of this column is a the Table of Contents (TOC) for this page. If you are authoring a page that requires a TOC, you can generate one automatically by toggling the toc = true frontmatter field (see How This Site Works for more information).

For example, to get a Header to show up in the TOC, you would type this:

To get a Sub Header to show up in the TOC, you would type this:

Structural Elements

Paragraphs

Consecutive lines of text are considered to be one paragraph. You must add a blank line between paragraphs.

Block Quotes

A blockquote is started using the > marker followed by an optional space; all following lines that are also started with the blockquote marker belong to the blockquote. You can use any block-level elements inside a blockquote:

Yields:

This is a sample block quote

Nested blockquotes are also possible.

Code Blocks

To create a code block, surround the code with three back-ticks, followed by a language abbreviation. For example:

…followed by the code…

…and finally closed by three back-ticks.

The abbreviation after the first set of back-ticks is the language code for syntax highlighting. We are using a syntax highlighting plugin called highlight.js. Many languages are supported. The most common language abbreviations used on this site are:

• cs is C#
• vbnet is Visual Basic
• python is Python
• cpp is C/C++

A complete list of language aliases can be found in the individual source files for highlight.js.

Horizontal Rules

Horizontal rules (lines) are created by using three dashes:

You can an example of one of these right here…

Lists

You can create ordered lists and unordered lists.

Ordered Lists

Ordered lists are created by typing 1. at the start of a line, like this:

yields:

This is an ordered list:

1. Item one.
2. Item two.
3. Item three.

Nested ordered lists are also possible. For example:

yields:

This is a nested ordered list:

1. Do item one.
   1. Item one subtask one.
   2. Item one subtask two.
2. Do item two.
3. Do item three.

Unordered Lists

Unordered lists (bullet lists) are created using the dash (-) symbol at the beginning of a line:

yields:

This is a bullet list:

• Item one
• Item two
• Item three

Tables

Markdown supports a syntax for creating simple tables. A line starting with a pipe character starts a table row. However, if the pipe characters is immediately followed by a dash (-), a separator line is created. Separator lines are used to split the table header from the table body (and optionally align the table columns) and to split the table body into multiple parts. If the pipe character is followed by an equal sign (=), the tables rows below it are part of the table footer.

Here is the syntax for a simple table:

yields:

| A simple | table | | with multiple | lines|

More complex tables can be added like this:

yields:

Header1	Header2	Header3
cell1	cell2	cell3
cell4	cell5	cell6
cell1	cell2	cell3
cell4	cell5	cell6
Foot1	Foot2	Foot3

Text Modifiers

Emphasis

Emphasis (bold and italic) can be added to text by surrounding the text with asterisks:

For example:

yields:

I like my coffee bold.

Links

Simple Links

A simple link can be created by surrounding the text with square brackets and the link URL with parentheses:

yields:

This is a link to the Rhino 3D homepage.

You can also add title information to the link:

yields:

A link to the homepage.

There is another way to create links which does not interrupt the text flow. The URL and title are defined using a reference name and this reference name is then used in square brackets instead of the link URL:

yields:

A link to the homepage.

If the link text itself is the reference name, the second set of square brackets can be omitted:

yields:

A link to the Rhino3D homepage.

Anchor Links

As discussed above, Headers and Sub Headers automatically create anchors in the resulting rendered html output.

You can link to any anchor within a page using the hash # symbol in a normal link. For example:

yields the sentence fragment shown above.

To create new anchors within the site, you can use html inline. For example:

was added to the top of this page.

Images

Images can be created in a similar way to links: just use an exclamation mark before the square brackets. The link text will become the alternative text of the image and the link URL specifies the image source:

yields:

Inline Code

Text phrases can be easily marked up as code by surrounding them with back-ticks:

yields:

To write a line to the command line use the Rhino.RhinoApp.WriteLine method.

Footnotes

Footnotes can easily be used in Markdown. Just set a footnote marker (consists of square brackets with a caret and the footnote name inside) in the text and somewhere else the footnote definition (which basically looks like a reference link definition):

yields:

This is a text with a footnote¹.

MathJax & LaTeX

Markdown has support for LaTeX to PNG rendering via MathJax.

For example:

yields:

$$y = {\sqrt{x^2+(x-1)} \over x-3} + \left| 2x \over x^{0.5x} \right|$$

See the MathJax basic tutorial and quick reference on StackExchange.

Shortcodes

Shortcodes are Hugo’s way of inserting a html into your content that generate some special type of formatted output. Hugo comes with some built-in shortcodes for things like inserting Vimeo or YouTube videos, Instagram or Twitter posts, etc. but we can author our own shortcodes to suit our needs.

So far, we’ve got the following shortcodes of our own:

3dm

Use the 3dm shortcode to embed a 3D view of a 3dm file to a page.

yields:

and

yields:

Required Arguments:

• path: string. Path to the 3dm file, for example file residing in the same folder as .md content file could be renference as path="example.3dm".
• width: String. Pixel or Percentage value for width of the element.
• height: String. Pixel or Percentage value for height of the element.

Optional Arguments:

• camera: JSON. XYZ Position of the camera. Example: camera=`{"x":0,"y":50,"z":50}`
• background: String. Background color of the viewer. Example: background="transparent"
• title: String. Text overlay at the bottom of the element.
• text_color: String. Text color of the title. Example: text_color="red"
• settings: JSON. General settings for the viewer. Example: settings=`{"controls":false, "camera":{"type":"orthographic", "fov":50, "zoom":8}}`
• animation: JSON. Flip trhough set of predefined cameras, titles (TODO: and layers). Has two sub-objects; settings and frames. Example: animation=`{"settings":{"repeat":1, "eachDelay":2, "eachDuration":2}, "frames":[{"title":"left","camera":{"x":10,"y":-30,"z":10},"layers":"*"},{"title":"right","camera":{"x":0,"y":40,"z":5},"layers":"*"},{"title":"front","camera":{"x":40,"y":0,"z":5},"layers":"*"}]}`

Anchor

Creates an empty div with the specified ID and can be used as an #anchor anywhere in the page:

{{< anchor "custom_anchor" >}}

produces an empty div above this line, and can be referenced with a link #custom_anchor

Awesome (Font Awesome)

Font Awesome provides a huge library of vector icons that area easy to use with this sortcode:

{{< awesome fas fa-check small >}} produces:

You can also specify a size and a color like this:

{{< awesome id="fab fa-windows" size="small" color="#49abe9" >}} produces:

BeforeAfter

You can create image-based before-and-after comparisons with the following shortcode:

produces:

You can also supply optional captions for the left and right images like this:

This shortcode uses the twentytwenty jQuery widget.

Call-Out

To call attention to a specific area of content on the page, use the call-out shortcode.

For example:

produces:

The following arguments can be passed to the shortcode to determine the type:

• note
• abstract
• info
• tip
• success
• question
• warning
• failure
• danger
• bug
• example
• quote

Align

produces

Center

Use the center shortcode to center images, text, etc. in the div.

For example:

produces:

You can center images too using the image argument like this:

produces

Figure

Use the figure shortcode to insert images with captions like this:

produces:

Optionally, you can also use the gallery and load-photoswipe shortcodes to embed figures in a gallery and pop-up an image overlay when users click or tap on the image.

Image (shortcode)

There is a basic image shortcode for doing simple sizing (this is an html resizing, not an actual image process - see imgproc below)…

Here is an example that changes the width of an image

produces

Image Processing (imgproc)

Hugo comes with a number of useful image processing routines like resizing and cropping. It’s important to understand that these are not just css styles, but actual processes the generate entirely new derivative files based on the image you use as your input. This is especially useful for generating thumbnails from large images so that a smaller (in kb) image is delivered in those situations where a larger one would cause slow pageloads. Think of these image processing routines as the equivalent of opening up your file in a program like Photoshop and performing resizing, format, or cropping operations on them.

To use the Image Processing routines on the page, use the imgproc shortcode.

Here is an example that resizes an image:

Make sure you close the final brace (not shown above, unfortunately) with a forward slash / like this…

produces

Latest Rhino Version

Avoid writing the latest Rhino version in text. Instead, the site itself knows which is the current shipping version. So use the following shortcode:

{{< latest-rhino-version >}} produces 8

Standard size:

{{< new-label 6 >}} produces:

Small size:

An inline {{< new-label 6 small >}} small new label produces:

An inline

small new label. There’s a bug here that causes a line-wrap in the middle. Brian doesn’t know how to fix it.

Bullet in list:

produces:

• 6
  Feature description
• A feature from a previous version
• 7
  A feature from a previous version

Open Rhino

To open URL in Rhino, use the:

to produce:

Open Clip.3dm in Rhino

To open Rhino by clicking an image:

Row and Column

Use the {{< row >}} and {{< column >}} shortcodes together to create responsive flow layouts like this:

produces:

Vimeo and YouTube Videos

Vimeo

We have extended the built-in vimeo shortcode to support Autoplay and looping…

For example:

produces:

YouTube

Hugo has a built-in youtube shortcode that can be used to embed videos like this:

produces:

What’s New

Wikipedia Link

Use: {{< wikipedia-link Cosmic_latte >}} to get: ikipedia: Cosmic latte

Related topics

• How This Site Works
• Markdown Cheatsheet

Footnotes

Edit this page

Edit on GitHub

History

Admin