Formatting

The docs section and other parts of our website are written in Markdown. The following pages provide a summary of the theme’s features with formatting examples. Please also see the Kramdown quick reference and our contributing guide.

• Tooltips

  You can add tooltips to any word, such as an acronym or specialized term. Tooltips work well for glossary definitions, because you don't have to keep repeati...

• Alerts

  You can insert notes, tips, warnings, and important alerts in your content. These notes make use of Bootstrap styling and are available through data referenc...

• Code samples

  You can use fenced code blocks with the language specified after the first set of backtick fences.

• Glossary layout

  Your glossary page can take advantage of definitions stored in a data file. This gives you the ability to reuse the same definition in multiple places. Addit...

• Links

  When creating links, you can use standard HTML or Markdown formatting. However, you can also implement an automated approach to linking that makes linking mu...

• Icons

  You can integrate font icons through the Font Awesome and Glyphical Halflings libraries. These libraries allow you to embed icons through their libraries del...

• Images

  Store images in the images folder and use the image.html include to insert images. This include has several options, including figcaptions, that extract the ...

• Labels

  Labels are just a simple Bootstrap component that you can include in your pages as needed. They represent one of many Bootstrap options you can include in yo...

• Lists

  This page shows how to create both bulleted and numbered lists

• Navtabs

  Navtabs provide a tab-based navagation directly in your content, allowing users to click from tab to tab to see different panels of content. Navtabs are espe...

• Pages

  This theme primarily uses pages. You need to make sure your pages have the appropriate frontmatter. One frontmatter tag your users might find helpful is the ...

• Posts

  You can use posts when you want to create blogs or news type of content.

• Syntax highlighting

  You can apply syntax highlighting to your code. This theme uses pygments and applies color coding based on the lexer you specify.

• Tables

  You can format tables using either multimarkdown syntax or HTML. You can also use jQuery datatables (a plugin) if you need more robust tables.

• Text

  You can use standard github-flavored markdown text formatting synatx and other formatting options supported by Kramdown, HTML tags, and CSS classes provided ...

• Workflow maps

  Version 6.0 of the Documentation theme for Jekyll reverts back to relative links so you can view the files offline. Additionally, you can store pages in subd...