Skip to content

Demo page #

This page contains available styles you can use when writing documentation. Enjoy!

Title 2nd#

Title 3rd#

Title 4th#

Bold text

Italic text

Highlighted text

Underlined text

Strikethroughed text

Inline Code text

# Inline code text with syntax highlight

def test()

Icons (e.g., , and ) and emojis (e.g., 😄, 😙 and 🥲) can be searched here

Image title

An image with caption

  • Finished TODO
  • Unfinished TODO
  • Subitem TODO #1
  • Subitem TODO #2
  • Subitem TODO #3

  • Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

  • Bullet point lists

  1. Numbered lists
# Block code text with python syntax highlight
import os
hello.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Block code text with a title and line numbers and highlighted lines
import rclpy
from rclpy.node import Node
import rclpy.time
from control_msgs.msg import DynamicJointState, JointJog
from geometry_msgs.msg import TwistStamped, PoseStamped
from tf2_msgs.msg import TFMessage
from airbot_msgs.msg import StateMsg
from airbot_msgs.srv import ControlModeSwitch
from moveit_msgs.srv import ServoCommandType, GetMotionSequence
from tf2_ros import Buffer, TransformListener
from typing import Optional, List
import threading
from bidict import bidict

A reference to the footnote1

Tables, and also icons:

Method Description
GET Fetch resource
PUT Update resource
DELETE Delete resource

Flow charts, see here

graph LR
  A[Start] --> B{Error?};
  B -->|Yes| C[Hmm...];
  C --> D[Debug];
  D --> B;
  B ---->|No| E[Yay!];

Sequence diagrams, see here

sequenceDiagram
  autonumber
  Alice->>John: Hello John, how are you?
  loop Healthcheck
      John->>John: Fight against hypochondria
  end
  Note right of John: Rational thoughts!
  John-->>Alice: Great!
  John->>Bob: How about you?
  Bob-->>John: Jolly good!

ER diagrams, see here

erDiagram
  CUSTOMER ||--o{ ORDER : places
  ORDER ||--|{ LINE-ITEM : contains
  LINE-ITEM {
    string name
    int pricePerUnit
  }
  CUSTOMER }|..|{ DELIVERY-ADDRESS : uses

Outlined Button

Filled Button

Note

This is a fancy note.

A note with a title

This is a fancy note with a title.

This is a fancy note with no title.

Note

This is a fancy note that is collapsible and collapsed by default.

Note

This is a fancy note that is collapsible and expanded by default.

Abstract

This is a fancy abstract.

Tip

This is a fancy tip.

Info

This is a fancy info.

Success

This is a fancy success.

Warning

This is a fancy warning.

Failure

This is a fancy failure.

Danger

This is a fancy danger.

Bug

This is a fancy bug.

Example

This is a fancy example.

Quote

This is a fancy quote.

  1. A footnote show at the bottom of the page ↩