Markdown Formats and Templates

The following sections provide simple formats for content. For additional formats, see markdown guides like Markdown Guide.

Elements of a Page

We provide templates (coming soon) to help create a new page. Every page includes the following:

• Frontmatter - This is the metadata for a webpage, including the title, description, and search keywords.
• Headings - These mark the sections, from H2 (##) to H5 (#####).
• Content - All of the content, including paragraphs, lists, instructions, images, graphs, and more.

Frontmatter

Every file begins with front matter or metadata for your content. This information includes:

---
title: Name of the page
description: Learn more about... 
---

Parameter	Description
title	The title of the page. Keep it short and unique.
description	1-2 sentences describing what the user will find in the page. This displays in searches on Google and in the site.

Paragraphs

As you start writing content, it automatically generates along the left side (or margin). To create a paragraph, leave an empty line between sentences.

If you need to indent content, use the tab key. Each tab moves content to the right, indenting the page content.

Text effects

To format for bolding and italics, see the following:

| Example | Output | | *emphasis* | emphasis | | **bold** | bold |

Bulleted lists

We recommend using a dash (-) for each line in a bulleted list. Lists also support *.

- List Item 1
- List Item 2
- List Item 3

Numbered steps

Numbered lists add numbers to a set of instructions or steps. Start every line with 1.. When building the documentation, the instructions automatically number for you.

1. Run composer update locally.
1. Add and commit these updated files to your Cloud Git repository.
1. Push the changes to your Cloud Integration environment.

Tables

Simple tables can help format content. For example, lists of attributes with descriptions. Adding the style below the table helps with formatting.

| Attribute | Description |
|--|--|
|name|Description of name|
|id|Description of ID|

Links

Adding links to content outside of documentation: [GitHub](http://github.com)

Adding links between pages are relative links:

[Topic Name](filename.md)

Images

We recommend saving all images in PNG format. Images are typically saved in the /static/images folder location.

Use the following format for placing images inline (paragraphs, tables, bullets, etc) and in its own line:

![Alt Text](/images/filename.png)

Annotations

Use annotations to highlight information, including tips, notes, warnings, etc.

(coming soon)

Code

Use the following formats for commands, API method names, and code.

Use single ticks around text in a sentence for code:

Use single ticks around `text` in a sentence for `code`:

For blocks of code, use triple ticks (```) before and after the code. If you know the code language, include that in the first set of ticks, for example ```json. This applies code highlighting for the language. See this list of available languages.

The following is an example of JSON:

{  
    "employee": {  
        "name":       "Jane Smith",   
        "team":      "Operations",   
        "manager":    true  
    }  
}  

Templates

To quickly create a page, use a template. You can copy and paste the file, add your content, and submit a PR. If you need formats for specific code, see the formats template.

(coming soon)

• Doc topic - Use for any documentation page
• APIs - Use for API and code
• Format template