Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 1.91 KB

example.md

File metadata and controls

81 lines (54 loc) · 1.91 KB
# Guide metadata is written in YAML
# Syntax reference: https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html

title: Example Guide
description: |
  Demonstrates how to make a guide, especially the metadata.
  Multiple lines are supported.
category: Examples
author: Your Name
tags:
  - example
  - tag 1
  - tag 2
hidden: true  # Only used for internal stuff, you can ignore this
# Close the codeblock, then you can write the guide content

Some things to note:

Guide content goes around here, keep in mind that you do not need a header for the title, and further headers should be at least header 2 (##)

Syntax demonstrations

Header 1

Header 2

Header 3

This keeps going forever

and ever
and ever

Italics

Bold

Bold Italics

Strikethrough

Underline

Inline code for commands and stuff

  • List item 1
  • List item 2
  • List item 3

Header 1 Header 2 Header 3
This is a table This is a table This is a table

Link with anchor text

A link: https://example.com

Image with alt text

Image with alt text

This image is a link:

image

HTML is supported, style and all.