Formatting with Markdown
Descriptions and multiline custom fields support Markdown. It's a simple format that allows structured and stylized text. This page explains the basics of Markdown and imPlural features and limitations.
The basics
New to Markdown? Have a look at this reference for the basics. imPlural supports the Markdown syntax described, with a few additional features:
Crossed out text
~~text~~Tick-box to-do list
- [ ]- [x]Plain web address becomes clickable links
example.comFancy icon
[icon:folder]This reference explains how tables work.
Images
You can add images with any (https) link, but by default they are not loaded automatically. If you're worried, it's good to verify the URL is legimite.
This is how blocked images look like:
Tap to load this image
example.comYou can change this setting in Settings → Interface.Images can have explicit size too if you want to control layout better. Use https://example.com/maomao.png#120x80 to make the image 120 x 80 pixels in size. You can also set the width alone with #120x or height with #x80.
Images can placed on the left side like this, by starting a line with an image. For example  Maomao is is a character we use often to give examples!. Text can become multiple lines safely next to an image.
Images can placed on the right side like this, by ending a line with an image. For example Maomao is is a character we use often to give examples! . Very long text can be layed below the image!
An image can also be in the middle of a line. Be careful as large images can cause text around it to look strange!
Icons
You can show the various icons imPlural supports (as folder icons for example) in descriptions. They support formatting. Crossed out text and icon doesn't render perfectly right now.
Fancy icon
[icon:folder]Currently the best way to find icon names is to open the Material Symbols reference and click an icon you like. The sidebar that opens has Icon name at the very bottom. That is the text you need to put in.
Code blocks
Code blocks support various formatting rules. Currently there is only 2: plain and text.
``` This is a code block with plain formatting. It's lines don't wrap at all. Useful for things like code, but not so much for descriptions. ```
```text This is a code block with text formatting. Look! All lines wrap nicely, and it looks fancy. Just remember to put that 'text' right after the backticks! ```
What is not supported
- HTML is disabled. They show as plain text. This ensures safe and consistent formatting.
- Syntax highlighting for code is not supported. Code blocks show as plain text.
Where you can use it
Markdown is supported on member, folder and user profile descriptions, and multiline custom fields. While editing, you see it as text. Once saved, you can see the result.