Style Guide (Modern)

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

Stylistic Conventions

There are various stylistic “voices” that can be used when authoring content for this site. Depending on your audience and the context - writing a guide is different from writing a new feature entry - you might employ different “voices,” conventions, different outlines, and even different exercises to get you started.

New Features: The Elevator Pitch

Before doing a video, forum post, blog post, or any new feature content, write down the answers to these simple questions: If you can’t answer them, don’t start creating content. Ask for help!

• Who is the new feature targeted at? Of course many potential users can benefit. But who is ideal? Be specific.
• Why do they want it? What compelling need does the feature satisfy? While there may be many needs, pick the one or two really compelling reasons customers will use the feature. What pain will the new feature make go away? What is a day in their life like both without and with the feature?
• What is the feature’s category (modeling, editing, rendering, export, etc.)?
• What is the key differentiator? Just pick the ONE that is most likely to keep someone’s attention.
• What was the alternative before this feature was available? This doesn’t necessarily mean another vendor’s product. It could be a more painful Rhino workflow.
• How is the new feature different from the alternative?

Armed with the answers, build an outline by filling in the following template to form a single paragraph:

For [ideal user]

who has [problem]

is a [category]

that [differentiator].

Unlike [fill in the competitor]

[fill in the key differentiator]

Technical 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 style-guide. Google treats a hyphen as a word separator, but does not treat an underscore that way. Google treats an 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.

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

Fonts

On Windows & macOS, this site attempts to use the Roboto typeface family and falls back to a sans-serif variant per OS if Roboto is not found. For typical body copy, Roboto is used with the following properties (font size: 16 px, font weight: 400, line height: 1.5). Specific heading and additional font properties are set within a CSS file.

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:

• “3D” is not hyphenated and D should be capitalized (not 3-D, 3-d, nor 3d).
• “Rhino 3D” has a space between Rhino and 3D (not Rhino3D, Rhino3d, Rhino-3D, Rhino-3d, Rhino3-D, nor Rhino3-d).
• “plugin” (plural plugins) is not hyphenated (plug-in and plug-ins are incorrect), unless it refers to a place in the Rhino UI where it is hyphenated.
• “Brep” or “B-rep” (both pronounced “bee-rep”, plural Breps or B-reps) not BREP, BRep, B-Rep, brep, or b-rep.
• “SubD” (plural SubDs with a lowercase s) is always capitalized without a hyphen (not Sub-D, SUBD, subd, Subd).
• “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.

Spacing & Punctuation

• Use one (1) space after end-of-sentence punctuation, not two (2) or more spaces (digital typography convention).
• Use one (1) space after a bullet point, unless two (2) spaces are used to help the spacing “breathe.”
• Periods and commas should go inside of quotation marks (American convention).
• Headings should always use title case where the first letter of main words are capitalized (This is Title Case and Correct. This is sentence case and incorrect).
• Headings should not use a colon (:) at the end, unless transitioning to paragraph text on the same line.
• Paragraph text should include an end-of-line colon to introduce a list on subsequent lines.
• 2-part headings should use a colon to separate primary & secondary info, but don’t use a colon twice (Primary: Secondary).
• 3-part headings should use a pipe (|) with a space on both sides then a colon with a space afterward (Primary | Secondary: Tertiary).

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:

## Headers

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:

## This Is My Header

the resulting html anchor tag would be:

#this-is-my-header

Read more about anchors here.

Subheaders

Subheaders demarcate sub-sections–a major section underneath a header.

Subheaders are created like this:

### Subheader

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

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.

Language

Anchors are automatically generated by parsing the English version of the heading text and formatting it to be URL-safe.

For example a heading text in fr\index.md that reads Grands projets will look for a corresponding heading in en\index.md to find Large Projects and format it to:

#large-projects

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:

### This & That

becomes:

#this--that

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:

### Heading Text {id="custom_anchor"}

Will generate two anchors:

#heading-text

and

#custom_anchor

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:

## Cool Header

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

### Sweet Subheader

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:

> This is a sample block quote
>
> >Nested blockquotes are also possible.

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…

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

public static Rhino.Commands.Result AddCircle(Rhino.RhinoDoc doc)
{
  Rhino.Geometry.Point3d center = new Rhino.Geometry.Point3d(0, 0, 0);
  const double radius = 10.0;
  Rhino.Geometry.Circle c = new Rhino.Geometry.Circle(center, radius);
  if (doc.Objects.AddCircle(c) != Guid.Empty)
  {
    doc.Views.Redraw();
    return Rhino.Commands.Result.Success;
  }
  return Rhino.Commands.Result.Failure;
}

…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 built into Go’s Chroma Highlighting engine. 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 List of Chroma Highlighting Languages.

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:

This is an ordered list:

1. Item one.
1. Item two.
1. Item three.

yields:

This is an ordered list:

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

Nested ordered lists are also possible. For example:

This is a nested ordered list:

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

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:

This is a bullet list:

* Item one
* Item two
* Item three

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:

| Header1 | Header2 | Header3 |
|:--------|:-------:|--------:|
| cell1   | cell2   | cell3   |
| cell4   | cell5   | cell6   |
| cell7   | cell8   | cell9   |

yields:

HTML Elements

markdown allows you to use block-level HTML tags (div, p, pre, etc) to markup whole blocks of text – just start a line with a block-level HTML tag.

Here is an example of using HTML elements:

<div style="float: right">
Something that stays right and is not wrapped in a para.
</div>

<div>
This is wrapped in a para.
</div>
<p>
This can contain only *span* level elements.
</p>

yields:

This can contain only *span* level elements.

Text Modifiers

Emphasis

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

For example:

I like *my* coffee **bold**.

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:

This is a [link](https://www.rhino3d.com) to 

yields:

This is a link to the Rhino 3D homepage.

You can also add title information to the link:

A [link](https://www.rhino3d.com "Rhino 3D homepage") to the homepage.

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:

A [link][rhino3d homepage] to the homepage.

[rhino3d homepage]: https://www.rhino3d.com "Modeling tools for designers"

yields:

A link to the homepage.

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

A link to the [Rhino3D homepage].

[Rhino3D homepage]: https://www.rhino3d.com "Modeling tools for designers"

yields:

A link to the Rhino3D homepage.

Anchor Links

As discussed above, Headers and Subheaders 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:

[Subheaders](#subheaders) automatically create anchors in the resulting rendered html output

yields the sentence fragment shown above.

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

<a id="top"></a>

was added to the top of this page.

Links with previews

Links wrapped in unfurl shortcode will try to show a preview of the link og meta data on hover. This only works for links to other pages on rhino3d.com and other mcneel sites that we configure for this purpose.

For example

{{< unfurl >}}[docs link](https://docs.mcneel.com/rhino/8/help/en-us/commands/clippingdrawings.htm){{< /unfurl >}}

will produce docs link which shows a preview when you hover over it.

You can optionally override the title, image and description that gets shown in the popup by providing the additional arguments. For example:

{{< unfurl title-override="...h" description-override="..." image-override="https://..." >}}[Rhino3D homepage](https://www.rhino3d.com){{< /unfurl >}}

produces Rhino3D homepage

Inline Code

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

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

yields:

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

HTML Elements

HTML is not only supported on the block-level but also on the span-level:

This is <span style="color: red">written in red</span>.

yields:

This is written in red.

MathJax & LaTeX

markdown has support for LaTeX to PNG rendering via MathJax.

For example:

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

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.

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:

![computelogo](/images/rhino_compute_logo.png)

yields:

Alternative, you can use the image shortcode as well, which accepts arguments for url, alt, width, and height.

Modern Style Layout

modern_style is the current (v9) page layout. It’s a cross-cutting page_options flag, not something specific to any one section — the same layout is used across docs/guides/, features/, and stories/ pages. Setting it on a page swaps its rendering for modern-guide.html, which supplies a hero, an optional sticky Table of Contents, and a restyled body (headings, lists, figures, call-outs, tables, etc.). This very page uses it.

Turning it on

page_options (like [modern] below) is a front matter table, so this goes in the page’s front matter, not in the body:

[page_options]
modern_style = true

Hero variants

Controlled by page_options.modern_hero:

The [modern] front matter table

Feeds the default and plain-header heroes:

[modern]
eyebrow = "How-To Guide"
lead = "Model an ergonomic handle using Patch, from a single reference curve."
hero_image = "images/brush-rendering.png"
meta = ["30–45 min", "Rhino 9 for Windows / Mac", "Intermediate"]

The video hero doesn’t use the [modern] table — it instead reads icon, commands, what_why, included_in.since, and whats_new.in_v7 directly off the page, so existing feature-page front matter keeps working unchanged.

Other layout options

Breadcrumbs are hidden by default: they add vertical space to the hero, and the auto-generated trail (.Ancestors, see modern-breadcrumbs.html) can link to section pages that aren’t ready or suitable to browse back to. Opt in only on pages with a meaningful ancestor trail:

[page_options]
modern_style = true
breadcrumbs = true

Content styling

Pages using modern_style automatically get restyled markdown: heading typography, plain numbered step lists, red-dot bullets, bordered figures with a click-to-zoom lightbox, bordered video/Vimeo embeds, restyled call-out boxes, hairline tables, and restyled unfurl reference cards. You don’t need to do anything extra to opt into this — it applies to standard Markdown and to the shortcodes documented below (figure, call-out, unfurl, etc.).

One shortcode is specific to modern_style pages: learn, for a “What you’ll learn” callout near the top of the page.

{{< learn >}}
- How to build a single-surface Patch brush from a reference curve
- How to check and adjust surface continuity
{{< /learn >}}

Reference examples

• Create an Ergonomic Brush Handle — default hero, TOC on, full [modern] table.
• Decals — modern_hero = "video", TOC off, no [modern] table.
• Free 90-day Evaluation — default hero, top-level page.

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.

{{< 3dm path="path_to_file.3dm" camera=`{"x":0,"y":50,"z":50}` width="80%" height="400px" >}}

yields:

and

{{< 3dm path="path_to_file.3dm" width="80%" height="400px" background="transparent" settings=`{"controls":false, "camera":{"type":"orthographic", "zoom":8}}` animation=`{"frames":[{"title":"perspective","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":"*"}]}` >}}

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:

Badge

Adds a round background around text.

For example: {{< badge background="#30ab8a" >}}1{{< /badge >}} produces: 1

BeforeAfter

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

{{< beforeafter "/images/before.png" "/images/after.png" >}}

produces:

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

{{< beforeafter "/images/before.png" "/images/after.png" "This text at left" "This text at right" >}}

This shortcode uses the twentytwenty jQuery widget.

Button

A link styled as the site’s pill button (the one on the homepage price cards). The label is the body, so it is translated with the page; add your own arrow if you want one.

{{< button link="/learn" >}}Start course →{{< /button >}} produces: Start course →

{{< button link="/learn" primary="true" >}}Build your first model{{< /button >}} produces: Build your first model

{{< button link="/learn" secondary="true" >}}Learn more{{< /button >}} produces: Learn more

Required Arguments:

• link: string. Where the button goes. A site-root path to a page (/learn2/) resolves to that page’s URL in the current language, exactly like a markdown link; external URLs, #anchors and files pass through.

Optional Arguments:

• primary="true": solid red style for the page’s main call to action, on modern-style pages only (elsewhere it shows the default pill). Use one per section at most.
• secondary="true": quiet outline style, e.g. for a Learn More next to a primary button.
• block="true": full width of its container, as at the bottom of a Card Container.
• new-tab="true": opens in a new tab.

Call-Out

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

For example:

{{< call-out danger "Here Be Dragons" >}}
Don't click that button man...it's dangerous dude.
{{< /call-out >}}

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
• new

Card Gallery

Wraps cards in a responsive grid that adds columns as the page gets wider. Use it around Feature Cards, Price Cards or Market Cards:

{{< card-gallery >}}
{{< feature-card page="/features/shrinkwrap/index.md" >}}
{{< feature-card page="/features/display/metal/index.md" >}}
{{< /card-gallery >}}

produces:

It takes no arguments.

Feature Card

A linked picture card: thumbnail, title and a one-line description, read from the front matter of the page you point it at (thumbnail, title, short_description). It is the card used for the features on /8/new and in the Learn Rhino section of the homepage. Always put it inside a Card Gallery.

{{< feature-card page="/features/shrinkwrap/index.md" >}}

produces:

Everything on the card can be overridden, so it can point anywhere, not only at the page it reads from. This is how the homepage builds its Learn Rhino cards:

{{< feature-card page="/learn/_index.md" url="/learn/?query=kind:%20jump_start" title="Getting Started" description="Jump right in at your comfort level" image="/images/getting-started.jpeg" >}}

produces:

Required Arguments:

• page: string. Path of the content file the card reads its defaults from, e.g. page="/features/shrinkwrap/index.md". Required even when you override everything else.

Optional Arguments:

• url: string. Link target. Default: the page’s URL.

• title: string. Default: the page’s title.

• description: string. Default: the page’s short_description, cut to 75 characters. A feature updated in the latest Rhino version shows its whats_new summary instead.

• image: string. One of:

  • a file in the site-wide /images/ folder: image="/images/getting-started.jpeg"
  • the name of an image in an images/ folder next to the page holding the card, so card artwork can live with the cards: image="black-white.png" finds images/black-white.png beside your page’s index.md
  • the name of an image next to the referenced page: image="thumbnail.png"

  A plain name is looked up in your page’s images/ folder first, then next to the referenced page. Default: the referenced page’s thumbnail. Images are cropped to 800×450. If the image can’t be found, the card shows no picture.

Align

{{< align left >}}Left Wing{{< /align >}}
{{< align center >}}Centrist{{< /align >}}
{{< align right >}}Right Wing{{< /align >}}

produces:

Center

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

For example:

{{< center >}}
This text is centered
{{< /center >}}

produces:

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

{{< center image >}}
![This image is centered](logo.png)
{{< /center >}}

produces:

Currency

The currency symbol of the visitor’s sales region: $ for NAPA, ASIA and LATA, € for EMEA, ¥ for JAPAN. It is the currency entry of the region’s table in data/pricing/en.toml.

{{< currency >}}195 produces: $195

For a complete price prefer Price, which also gets the number and the language’s formatting right.

Command

Command What’s New

Discourse Gallery

Use the discourse-gallery shortcode to embed a Discourse gallery with thumbnails as an iframe.

{{< discourse-gallery category="136" per-page="3" top-period="all" >}}

produces:

Arguments:

• category: Number. Restrict topics to a single category. Pass the id of the target category.
• tags: String. Restrict topics to those associated with this tag.
• per-page: Number. Controls how many topics to return. We suggest multiples of 3.
• template: String. Either complete (default) or basic While basic is just a list of topic titles, the complete template brings title, user name, user avatar, and topic thumbnail.
• top-period: String. One of all (default), yearly, quarterly, monthly, weekly, daily.

Figure

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

{{< figure src="/images/light-falloff-after.png" caption="Lights have a falloff value that can be set to inverse squared which mimics how light fades with distance." caption-align="center" >}}

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.

Gallery

The gallery shortcode used to show multiple images in a thumbnail grid. It is used in conjuction with the figure and load-photoswipe shortcodes like this:

{{< gallery >}}
  {{< figure src="/images/quadremesh-thumbnail.png" caption="Horse mesh retopologized" >}}
  {{< figure src="/images/pbr_material.png" caption="A PBR Material" >}}
  {{< figure src="/images/project.jpg" caption="Look! A toaster!" >}}  
{{< /gallery >}}
{{< load-photoswipe >}}

produces:

This shortcode uses the hugo-easy-gallery shortcode, along with Photoswipe.

Hover-card grid

Pass hover-card="true" to render a fixed-column grid (3 columns by default, use columns to change it) where each tile’s title sits over the image and its caption folds out below the tile as a description on hover or keyboard focus, styled like the site’s unfurl link-preview tooltip. Keep caption to about two short sentences — it isn’t truncated, so longer text will just make the popover taller. This mode ignores caption-position, caption-effect, and hover-effect. On narrow screens the grid collapses to a single column and the description is always shown instead of folding out.

{{< gallery hover-card="true" >}}
  {{< figure src="/images/quadremesh-thumbnail.png" title="Retopology" caption="Horse mesh retopologized into a clean quad layout for animation." >}}
  {{< figure src="/images/pbr_material.png" title="PBR Material" caption="A physically based material rendered in the Rhino viewport." >}}
  {{< figure src="/images/project.jpg" title="Toaster" caption="Look! A toaster! Modeled entirely from NURBS surfaces." >}}
{{< /gallery >}}

produces:

Hotlink

This is a link aligned to the right used as a link for additional information about a specific topic. It is removed when printed. As an example:

{{< hotlink >}}
[Link Text](Link)
{{< /hotlink >}}

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

{{< image url="logo.png" width="250px" >}}

produces:

Image Accordion

Use image-accordion with nested image-accordion-item shortcodes to create an interactive feature showcase: a full-bleed background image or video with a frosted-glass expandable menu on the left.

{{< image-accordion >}}
{{< image-accordion-item title="Feature one" image="images/photo.jpg" >}}
Short description of this feature.
{{< /image-accordion-item >}}
{{< image-accordion-item title="Feature two" image="images/photo2.jpg" >}}
Short description of this feature.
{{< /image-accordion-item >}}
{{< /image-accordion >}}

The image parameter can be a page-bundle image path, an absolute URL, or a video URL (.mp4, .webm, .ogg, .mov). Video backgrounds autoplay muted and looped.

yields:

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:

{{< imgproc "logo.png" "Resize" "48x48" >}}

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

Load Photoswipe

The load-photoswipe shortcode loads the javascript libraries on this page in order to support clicking or tapping on an image to show a lightbox-style image overlay. You only need to call it once per page like this:

{{< load-photoswipe >}}

and the library will load.

Keyboard

Adds styling around text to make it look like a keyboard key.

For example: {{< keyboard >}}Enter{{< /keyboard >}} produces: Enter

You can put anything between the opening and closing tags. Here are some common keys:

New Label

Use the New Label along with the included_in.since frontmatter field to create version-specific “new” labels.

Standard Size:

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

Small Size:

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

An inline

Bullet in List:

  * {{< new-label 6 bullet >}} Feature description
  * A feature from a previous version
  * {{< new-label 7 bullet >}} A feature from a previous version

produces:

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

Nugget

Define a Nugget

The following puts a hidden marker into the rendered HTML that can be used in later parsing. The nugget begins immediately after the marker, and ends at the next nugget definition. If no other nugget is defined, the nugget goes to the end of the file.

{{< nugget name='[NUGGET-NAME]' >}}

CAUTION: embedded videos don’t work in nuggets unless you use the {{< local-video >}} shortcode.

Include the Nugget:

{{< include-nugget src="../../path/to/topic/index.md" name='[NUGGET-NAME]' >}}

This will insert the nugget into the documet at this location.

Open Rhino

To open URL in Rhino, use the:

{{< open-rhino 
    "Clip.3dm"
    "Open Clip.3dm in Rhino"
     />}}

to produce:

The file URL should be relative to the index.md file you’re referencing it from. Alternatively you can use a full URL starting with http

To open Rhino by clicking an image:

{{< open-rhino "Clip.3dm" >}}
![computelogo](/images/rhino_compute_logo.png)
{{< /open-rhino >}}

Page Break

Manual Page Breaks can be inserted by this shortcode:

{{< page-break >}}

<p style="page-break-after: always;">&nbsp;</p>
<p style="page-break-before: always;">&nbsp;</p>

\rhino3d.com\themes\rhino3d.com-theme\assets\scss_print.scss

  h3, h4 {
    page-break-after: avoid;
  }
  pre, blockquote {
    page-break-inside: avoid;
  }
  div.details {
    page-break-inside: avoid;
    page-break-before: avoid;
  }

Page Search

Create a search bar to search through the contents of the page. Use shortcode below:

• elements is a list comma separated list of html elements.
• weights is their corresponding importance in the search results.

{{< page-search elements="h1, h2, h3, search-tag" weights="5, 1, 20, 100" >}}

to produce:

Price

A price from the site-wide price table, inline. Same lookup as Price Card: the row named by type, for the visitor’s sales region, written the way the page’s language writes prices. Plain text, so it works inside bold, links and headings.

Rhino costs {{< price "commercial" >}}, or {{< price "commercial-upgrade" >}} to upgrade. Students pay **{{< price type="edu" >}}**.

produces:

Rhino costs $995, or $595 to upgrade. Students pay $195.

Required Arguments:

• type: string, positional or named. Row of data/pricing/en.toml: commercial, commercial-upgrade, edu, edu-upgrade, eval, and the Buy page keys such as rhino-10 or bongo. An unknown type renders a visible error.

To add or change a price, edit data/pricing/en.toml (and the language file that overrides it, if any); see Regions & Pricing.

Price Card

The pricing “plan” card from the homepage and the Buy page: a title, a big price, a subtitle, a body of markdown and a button. Prices are never typed into a page. type names a row of the site-wide price table, data/pricing/en.toml, and the card shows that row for the visitor’s sales region, written the way the page’s language writes prices. Put several in a Card Gallery to lay them out in a grid.

{{< card-gallery >}}
{{< price-card title="Evaluation" type="eval" subtitle="No credit card required" action="Try It" ribbon="free" link="/downloadeval/" >}}
{{< center >}}
90 day trial license

Support included
{{< /center >}}
{{< /price-card >}}
{{< price-card title="Commercial" type="commercial" upgrade="true" subtitle="One time purchase" featured="true" link="/sales" >}}
Perpetual license. Support and service releases included.
{{< /price-card >}}
{{< price-card title="Student" type="edu" subtitle="Proof of status required" action="Learn More" secondary="true" link="/for/education" >}}
Same as the commercial version. Not transferable.
{{< /price-card >}}
{{< /card-gallery >}}

produces:

The body between the tags is markdown; the homepage wraps it in {{< center >}}. For a price in running text use Price. How the table, regions and languages fit together is in How This Site Works.

Required Arguments:

• title: string. Shown in uppercase at the top of the card.
• type: string. Row of the price table, e.g. type="commercial". The card also reads <type>-upgrade and <type>-promo when they exist. An unknown type renders a visible error, never an empty price.

Optional Arguments:

• subtitle: string. Line under the price.
• action: string. Button text. Default: Buy Now.
• link: string. Button URL. When set, the whole card is clickable.
• ribbon: string. Text of the diagonal corner ribbon, e.g. ribbon="free".
• upgrade="true": adds an “Upgrade from older version” line with the <type>-upgrade price.
• featured="true": marks the plan as the featured one (accent border). Only styled on modern-style pages such as the Buy page prototype; elsewhere it adds the plan-featured class and nothing visible.
• secondary="true": quiet button style, e.g. for a Learn More link. Like featured, only styled on modern-style pages today.

Promotions

When the table has a <type>-promo price and today is before promo_until in data/pricing/en.toml, the card strikes the list price and shows the promo price. A ribbon on such a card is treated as the promo ribbon and disappears when the promo ends, so nothing in content has to change when a promo starts or stops.

Search-Tag

These act as a hidden elements so they can be scrolled to. For example if you search for “Search for me” in the search bar above:

{{< search-tag "Search for me" >}}

Will scroll to right here.

Rhino Commands

Produces an icon followed by label of a Rhino command inline. For example use:

{{< rhino-command english-command="MeshBooleanUnion" local-command="UniónBooleanaDeMallas">}}

produces:

UniónBooleanaDeMallas

This shortcode pulls the command icon from docs.mcneel.com and expects the name of the image to match the english name of the command. But that’s not always the case. For example the name of the image for Rectangle command is rectangle_corner. In such cases, you can pass an additional image-name parameter to fix it.

{{< rhino-command english-command="Rectangle" local-command="Rectangle" image-name="rectangle_corner">}}

Rectangle

Rhino Icon Link

Produces a custom icon followed by a custom label, linking to a custom URL (for example, a specific Rhino help topic). Unlike rhino-command, nothing is derived automatically — you provide the name, URL, and icon yourself. For example use:

{{< rhino-icon-link name="Revolve" url="https://docs.mcneel.com/rhino/8/help/en-us/index.htm#commands/revolve.htm" icon="revolve.svg" >}}

produces:

Revolve

The name parameter is the display label. The url parameter is the link target, typically a Rhino help page. The icon parameter is the filename (including extension, e.g. .svg or .png) of an icon placed in static/images/icons, served from /images/icons/.

Grasshopper Components

Produces a Grasshopper component icon followed by its name, linking to the component’s page in the Grasshopper docs. For example:

{{< gh-component name="Circle" page="Params/Circle" icon="Grasshopper/Params/Geometry/Circle" >}}

produces:

Circle

The name parameter is the display label. The page parameter is the slug of the component page under /docs/grasshopper/. The icon parameter is the path to the component icon under https://www.rhino3d.com/static-media/docs/grasshopper/icons/, following the pattern Library/Category/Subcategory/ComponentName. If icon is omitted, it defaults to name.

Rhino Download

To produce a link to a Rhino download page, use the:

  * {{< rhino-download >}}
  * {{< rhino-download 7 windows evaluation >}}
  * {{< rhino-download 7 windows commercial >}}
  * {{< rhino-download evaluation >}}
  * {{< rhino-download commercial >}}

to produce:

• Download Rhino 8 Evaluation for Windows or Mac.
• Download Rhino 7 Evaluation for Windows.
• Download Rhino 7 for Windows.
• Download Rhino 8 Evaluation for Windows or Mac.
• Download Rhino 8 for Windows or Mac.

The acceptable arguments are:

1. version eg: 7, 8, 9 (major versions only). Note: If the version value is greater than the currently shipping version of Rhino (.Site.Params.latestRhinoVersion), the wip version of the shortcode is rendered.
2. platform eg: windows or mac
3. type eg: beta, wip, or commercial.

Without any arguments, a link to the latest commercial version on each platform is produced:

{{< rhino-download >}}

results in :

• Download Rhino 8 Evaluation for Windows or Mac.

Row and Column

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

{{< row >}}
{{< column >}}
Row 1: Column 1
{{< /column >}}
{{< column >}}
Row 1: Column 2
{{< /column >}}
{{< column >}}
Row 1: Column 3
{{< /column >}}
{{< /row >}}
{{< row >}}
{{< column >}}
Row 2: Column 1
{{< /column >}}
{{< column >}}
Row 2: Column 2
{{< /column >}}
{{< column >}}
Row 2: Column 3
{{< /column >}}
{{< /row >}}
{{< row >}}
{{< column >}}
Row 3: Column 1
{{< /column >}}
{{< column >}}
Row 3: Column 2
{{< /column >}}
{{< column >}}
Row 3: Column 3
{{< /column >}}
{{< /row >}}

produces:

Segmented

The two-way New License / Upgrade switch above the homepage prices: a pair of radio buttons styled as a segmented control that shows one of two target elements.

{{< segmented A="New License" Atarget="#seg-new" B="Upgrade" Btarget="#seg-upgrade" >}}

<div id="seg-new">
Shown while <b>New License</b> is selected.
</div>

<div id="seg-upgrade" style="display: none;">
Shown while <b>Upgrade</b> is selected.
</div>

produces:

Optional Arguments:

• A, B: string. Labels of the two segments. Default: A / B.
• Atarget, Btarget: string. CSS selectors of the elements to show for each segment, normally #some-id.
• Bquery: string. Query string that pre-selects B when the page loads. The homepage uses Bquery="upgrade=1" so that /?upgrade=1#price (linked from e-news mailings) opens on Upgrade. key alone matches on presence, key=value on an exact value.

Slideshow

Use the slideshow shortcode to embed a sliding gallery of pictures.

{{< slideshow dir="path" height="450px" mode="cover" auto-slide="2000">}}

Slideshow shortcode shows the name of the images under each slide.

Required Arguments:

• dir: string. the relative path of folder in /static containing the images.

Optional Arguments:

• width: string. pixel or percent value for overall width.
• height: string. pixel or percent value for overall height.
• mode: string. can be either "cover" or "contain".
• item-width: string. pixel value for individual slide width when mode is "contain", is ignored in "cover" mode.
• auto-slide: number. providing a value causes automatic transition of slides, value is delay between slides in milliseconds.
• arrow-left and arrow-right: string. font-awsome icon name for slideshow controls.

Carousel

carousel shortcode creates and infinitely scrolling gallery with zooming effect on the center image. The inner content of this shortcode is a toml list of items with caption and image URL.

{{< carousel id="iphone"  caption="true" height="500px" mode="contain" auto-slide="3000">}}

  [[items]]
  caption = "groups"
  image = "https://www.rhino3d.com/new-source/images/groups.png"

  [[items]]
  caption = "iRhino"
  image = "https://www.rhino3d.com/new-source/images/iRhino.webp"


{{< /carousel >}}

yields:

Required Arguments:

• items: toml. at least two items with caption and image entries. image URL should be complete URL of image in in new-source version of the site.

Optional Arguments:

• height: string. pixel or percent value for overall height.
• mode: string. can be either "cover" or "contain".
• auto-slide: number. providing a value causes automatic transition of slides, value is delay between slides in milliseconds.

Image-Fade

image-fade shortcode indefinitely fades through provided images at given interval

{{< image-fade width="500px" focus="3000" fade="500">}}

  [[items]]
  image = "https://www.rhino3d.com/new-source/images/lands+grasshopper.png"

  [[items]]
  image = "https://www.rhino3d.com/new-source/images/lands+twinmotion2.png"


{{</ image-fade >}}

yields:

Required Arguments:

• items: toml. at least two items with image entry. image URL should be complete URL of image in in new-source version of the site.

Optional Arguments:

• width: string. pixel or percent value for overall width.
• height: string. pixel height.
• mode: string. can be either "cover" or "contain". (only relevant when using images of different aspect ratio - NOT RECOMMENDED)
• focus: integer. duration in milliseconds that each slide is displayed.
• fade: integer. duration in milliseconds of fade transition between slides.

Subscribe

Use the subscribe shortcode to embed a button in the page that subscribes the user to the specified maillist.

{{< subscribe maillist="market_segment" id="27" label="Sign up for Virtual Reality news" >}}

Please log into your Rhino Account to subscribe to this mailing list.
<br>
<br>
<a class='rhino-btn' href='https://www.rhino3d.com/user/login/' target="_blank">Login</a>

{{< /subscribe >}}

yields:

Required Arguments:

• maillist: string. the name of the mailing list category matching of of the following "market_segment", "companion_product" or "profession".
• id: integer. the id of the mailing list corresponding to ids defined in the database see https://github.com/mcneel/rhino3d.com/blob/master/content/en/my-account/maillist/maillist.toml for a complete list of IDs.

Optional Arguments:

• label: string. human readable label of the button. (This value should be translated)
• class: string. name of css class to customize placement of the button, for example class="fixed-bottom-left" places the button on the bottom left corner of the page. Additional classes may be defined in page/global stylesheets.
• container: string. id of existing html element to move the button to, this can be any element that’s accessible on the page. For example table of contents has two empty elements on top and bottom of it that can be used for this purpose. container="toc-top-container" places the widget on the top of the table of contents. Similarly container="toc-bottom-container" places the widget on the bottom of table of contents.

Inner Body:

Content between shortcode’s opening and closing tags will be displayed in a modal when user is not logged in. The example above has a login button along with a message. (Content should be translated)

Tabs

A tabbed control with any number of panels. Each panel is a {{< tab >}} nested directly inside {{< tabs >}}; the body of a tab is regular markdown and can hold other shortcodes (Price Card, Call-Out and Card Gallery are known to work — not Unfurl, which can’t be nested inside any shortcode).

{{< tabs id="fruit" >}}
{{< tab label="Apples" >}}
Crisp. Also good in pies.
{{< /tab >}}
{{< tab label="Oranges" name="citrus" >}}
Peel first.
{{< /tab >}}
{{< /tabs >}}

produces:

Tabs are keyboard accessible (arrow keys, Home, End) and deep-linkable: the buttons are #<id>-<name> and the panels #<id>-<name>-panel, so #fruit-citrus opens the second tab, and clicking a tab updates the URL hash. Like Segmented, you can have several on one page.

tabs Optional Arguments:

• id: string. Prefix for the tab and panel ids. Default: tabs-<n>. Set it whenever you want links to stay stable.

tab Required Arguments:

• label: string. Button text.

tab Optional Arguments:

• name: string. Slug used in the ids. Default: the label, urlized (Students or faculty becomes students-or-faculty).

Inside a tab, avoid a blank line followed by indented HTML: markdown turns the indented lines into a code block.

Testimonial

A pull quote with attribution, as in the Who Uses Rhino? section of the homepage. The body is markdown; type the quotation marks yourself, so each language keeps its own convention.

{{< testimonial author="Scott Schneider, Film Designer" link="https://www.imdb.com/name/nm0774021" >}}
"I've been using Rhino for 20 years. It's the backbone of my work."
{{< /testimonial >}}

produces:

Several side by side, as on the homepage, is Row and Column with one testimonial per column.

Required Arguments:

• The body: the quote itself, as markdown.

Optional Arguments:

• author: string. Attribution under the quote, e.g. author="Scott Schneider, Film Designer".
• link: string. URL the attribution links to; opens in a new tab. Ignored without author.

Viewport

Adds styling around text to make it look like a rhino viewport title.

For example: {{< viewport >}}Perspective{{< /viewport >}} produces: Perspective | ▾

Vimeo and YouTube Videos

Local Video

Play mp4 files embedded directly in the site. This shortcode is necessary if you also use nuggets.

{{< local-video src="patch.mp4">}}

Vimeo

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

For example:

{{< vimeo id="447325407" autoplay="1" loop="1" autopause="0" >}}

produces:

Update: Optional padding parameter added to make the iframe size fit the video tightly. The value for padding varies and depends on the aspect ratio of the video. Vimeo calculates this when you try to get the embed code for a video. Simply copy and paste the xx.xx% (including the %) to padding parameter: padding=xx.xx%

YouTube

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

{{< youtube TeTiZuSbQz8 >}}

produces:

Year

Prints out the current year. Useful for copyright notices, etc.

For example:

{{< year >}}

produces:

What’s New

Wikipedia Link

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

Print Formatting

This guide also has `@media=“print” formatting that can be used to format PDF printed pages properly.

Page Break for Printing

Manual Page Breaks can be inserted by this page-break shortcode:

{{< page-break >}}

Automatic Print Formatting

Specific print formatting based on CSS styles can be to the file

\rhino3d.com\themes\rhino3d.com-theme\assets\scss_print.scss

For instance, this code will Avoid breaking the Section Titles with the first paragraph of the body.

  h3, h4 {
    page-break-after: avoid;
  }

This code will make sure paragraphs and notes stay together:

  pre, blockquote {
    page-break-inside: avoid;
  }
  div.details {
    page-break-inside: avoid;
    page-break-before: avoid;
  }

Headers, footers, and page numbers are also added to each page when printed.

Related Topics

• How This Site Works
• markdown Cheat Sheet