PeepSo Docs

Markdown Configuration

What is Markdown?

Markdown is widely used across the web. It’s the cornerstone of quick, simple and safe text formatting.
In essence, Markdown is a lightweight markup language with plain text formatting syntax. It is designed so that it can be converted to HTML and many other formats using a tool by the same name. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.

Where Can I Use It?

It can be used in both Posts and Comments throughout PeepSo.
There are settings where you can allow Markdown in Posts and / or Comments.
Navigate to WP Admin -> PeepSo -> Configuration -> Markdown and flip the switches. There’s also a quick cheat sheet on available Markdown formatting.

Markdown also can be used in PeepSo profile fields for Text Field type only, you just need to change the Appearance > Display setting to MarkDown formatted.


The Available Ways To Format Text:

  • BOLD: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis feugiat tortor risus, vitae volutpat lacus volutpat a. Sed vitae sapien augue. Curabitur posuere nec felis eu pretium. by using: **DoubleAsterisks**
  • Italic: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis feugiat tortor risus, vitae volutpat lacus volutpat a. Sed vitae sapien augue. Curabitur posuere nec felis eu pretium. by using:*SingleAsterisk*
  • Strikeout: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis feugiat tortor risus, vitae volutpat lacus volutpat a. Sed vitae sapien augue. Curabitur posuere nec felis eu pretium. by using:~~DoubleTilde~~

The above text formatting styles can be combined too. You can do what you want.

Lists

Markdown can also create ordered lists. Simply write a number and a dot / full stop, like this: 1. Milk 2. Bread 3. Butter 4. Chese and it will turn it int to:

  1. Milk
  2. Bread
  3. Butter
  4. Cheese

You can also create unordered lists. Similarly to ordered lists you can just put a dash or an asterisk in front of a word. Like: – / *. Lists will then be created.

  • Milk
  • Bread
  • Butter
  • Cheese

Code

You can also include inline code by putting `in front of a line of code and closing with the same symbol`.