Skip to main content

Styleguide

Admonitions​

We adopt the default Admonition colors for Note, Tip, Info, Caution, Danger by docusaurus:

Docusaurus Admonitons

note

Some content with Markdown syntax.

tip

Some content with Markdown syntax.

info

Some content with Markdown syntax.

caution

Some content with Markdown syntax.

danger

Some content with Markdown syntax.

Blockquotes​

Blockquotes should be handled with standard markdown >

Example Blockquote:

The raw data format is really the only sensible format option to use with RBD. asdasdasdasd asd asd a Technically, you could use other QEMU-supported formats (such as qcow2 or vmdk), but doing so would add additional overhead, and would also render the volume unsafe for virtual machine live migration when caching (see below) is enabled.

Codeblocks​

We support markdown language features for Codeblocks. It is mandatory to define the language to be quoted, when using codeblocks. Syntax Highlighting is also supported by Docusaurus via Prism. We are using the GitHub language themeing as default.

Python example
def code_block():
  # Everything in this function is part of the same code block
  print (1)
  print (2)

for i in range(4):
  # Everyting in this loop is part of the same code block
  print (i)
Javascript example
const code_block = () => {
  console.log('inside code_block')
}
YAML example
---
doe: 'a deer, a female deer'
ray: 'a drop of golden sun'
pi: 3.14159
xmas: true
french-hens: 3
calling-birds:
  - huey
  - dewey
  - louie
  - fred
Ruby example
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html