Markdown Formatting

Author: y2kid

Foreword

cplbw uses a stripped version of Markdown for handling user-submitted text such as guides/notes/comments etc. This guide will introduce the supported elements in the webapp's Markdown language by giving examples on how to create the elements and show how they are rendered.

Formatting

Headings

You can insert text headings by adding the # symbol on a new line followed by some text.

# Example
renders

Example

You can also have sub-headings by inserting multiple # symbols at the beginning of a new line.

## Like so
renders

Like so

### And so on
renders

And so on

Text

To add styling to text, you can use the * symbol.

Italics

To make text render in italics you should surround it by the * symbol.

*Example*
renders
Example

Bold Text

To make text bold you can surround it by two * symbols.

**Example**
renders
Example

Free Text

To add free text, such as code snippets or to force the interpeter to not render your text you should use three backtick symbols ```.

Example for this text is more difficult. Surrounding text with the three `
will render
this

Note:
The backtick character ` is not the same as a single quotation character '.

Linebreaks

Linebreaks are handeled in one of two ways:

  • Linebreaks between different paragraphs

To add a linebreak between two paragraph you should leave two empty lines between the paragraphs

Like

This

  • Linebreaks within the same paragraph

To add a linebreak within the same paragraph you can either leave two blank characters at the end of the pervious line.

like
so

Alternatively, you can use the <br/> sequence to force a linebreak within the same paragraph.

like <br/> so
renders
like
so

Quotations

To quote text you can use the > character at the beginning of a line.

Example

Structured Text

To add lists to your text you can either use 1. 2. 3. etc or the * symbol. Depending on the type of list you want

Note:
Lists need to be separated by at least one blank line with any preceding text.

Ordered Lists

To make an ordered list you can use 1. 2. 3. Every digit needs to be on a separate line and there must be an empty space character between the dot and the first letter.

  1. Like
  2. This

Note:
You can have multiple lines in an ordered list, but you cannot have multiple paragraphs.

Unordered Lists

To make an unordered list you can use the * character.

  • Like
  • so

Hyperlinks

You can insert hyperlinks by adding the word(s) to be linked in square brackets [] followed by the link in brackets

[cplbw.com](https://cplbw.com/)
renders
cplbw.com

Images

You can insert images by dragging the image in the editor field. The image will be uploaded automatically and inserted into the document.

Bug Reporting and Feature Requests

This guide introduced the supported markdown elements and showed how to use them. The version supported by the webapp is sufficient to serve our needs and limited to prevent security exploits. However, if something does not work as intended or you think that the provided functionality is insufficient you can always contact me, y2kid, in the official cpl discord to provide feedback.