ui_comp_procedures_template.md

layout	group	subgroup	title	menu_title	menu_node	menu_order	version	github_link
default	UI Components					1	2.0	contributor-guide/basic_template.md

Overview

One or two sentences, describing what is the procedure and when the user might need it. High-level workflow.

Prerequisites (if relevant)

What preparations are required, what a user should be familiar with.

Actual steps

Intro sentence (ex.: To make coffee, take the following steps:)

1. First Step
2. Second Step
3. Third Step

For big steps, add info how to validate that step was successful.

For the whole procedure, add info how to validate that procedure was successful, and what to do if not.

Formatting reference

Basic Markdown Syntax

Below are some basic examples of what you can do with markdown.

For more examples of basic markdown please follow this link{:target="_self"}.

Lists

Lists are useful for organizing and displaying related items. Below are examples of a bulleted list and an ordered list.

Bulleted List:

* List Item 1
* List Item 2
* List Item 3

Output:

• List Item 1
• List Item 2
• List Item 3

Ordered List:

1. First Step
2. Second Step
3. Third Step

Output:

1. First Step
2. Second Step
3. Third Step

Code blocks

By indenting your content by at least 4 spaces, you can create a code block.

//This is a code block!
print "Hello World!";

Code blocks can also be defined by surrounding the block of code with ~~~ which can be seen in the table example.

For highlighted code blocks use the highlight Liquid tag.

Example:

{% highlight html %}

Title

Paragraph content.

{% endhighlight %}