• 
      

    Markdown demo

    Review Request #3 — Created May 21, 2024 and updated

    Information

    5

    Reviewers

    Review Board supports Markdown in text fields

    Markdown is a syntax for marking up text. There's a lot you can do with
    it, from adding bold text, italics, sampleCode(), links, and more
    complex things, like:

    Unordered lists

    • Bullet-point lists

    • With multiple items

      • And sub-lists

    Ordered lists

    1. Ordered lists

    2. Also with multiple items

      1. And sub-lists.

    Fenced code blocks

     ```python
     def my_function(self):
         """Docstring"""
         for i in range(1, 10):
             print i
     ```
    

    Renders:

    def my_function(self):
        """Docstring"""
        for i in range(1, 10):
            print i
    

    Images

    Logo

    These all work in all multi-line text fields of a review request, on
    reviews, and on comments. Very useful for proposing new code!

    Emoji shortcodes

    You can also use standard Emoji shortcodes, like:

    Code Emoji
    :heart: ❤️
    :+1: 👍
    :star: ⭐
    :hamster: 🐹

    Tables

    Yep, you saw it. Tables are supported. This:

    | Column 1 | Column 2 | Column 3 |
    | -------- | -------- | -------- |
    | Text     | Text     | Text     |
    | Text     | Text     | Text     |
    | Text     | Text     | Text     |
    

    Displays:

    Column 1 Column 2 Column 3
    Text Text Text
    Text Text Text
    Text Text Text

    Use it anywhere!

    Markdown works in all text fields, both for review requests and in reviews.

    See our Markdown reference.