How to Write a nicely formatted post in Discourse/Forum

Writing a well formatted post in the forum (Discource powered) is important, if you want readers to easily read and understand.
It's especially important for terminal output.
Here is a brief tutorial.


Terminal output

For terminal output, text output with special characters, always use code wrapping (Pre-formated text).
Select all of the text and do one of these:

  • Hit the </> button in Discource Post Toolbar.
  • Press CtrlShift+C on your keyboard.

Manually with markdown

After you Copy your text, ...

For a Block of text

  • one line with 3 "back-ticks" (usually the key under Esc),
  • one empty line hitting Enter
  • one more line with 3 "back-ticks"
  • press Up Arrow to go in the empty line and Paste clipboard contents (Ctrl+V)

Example:

Write this
```
Text from terminal output
```
to get this

Text from terminal output

For Inline text

  • one "back-tick" at the beginning and one at the end of a word/phrase

Example:

Write this

Use `sudo pacman -Syu` to update your system

to get this

Use sudo pacman -Syu to update your system


Quoting paragraph (which is often wrongfully used for terminal output) :

  • Start the paragraph with >

Write this

> My smart answer 

to get this

My smart answer

  • To combine paragraphs and/or empty lines, use > in empty lines between
> Nice idea
>
> One more idea
> 

Nice idea

One more idea


Section titles

Start paragraph with 1 up to 5 # followed by a space, like

# Top level 

Top level

## 2nd level 

2nd level

### 3rd level 

3rd level


Separate sections with a horizontal line

  • Create an empty line (with Enter) followed by a line with 3 dashes, or 3 asterisks

 --- 

or


***

Create lists

Numbered list

Start the line with a number, a dot and a space

1. First
2. Second
3. Third 
  1. First
  2. Second
  3. Third

Bulleted list

Start the line with an asterisk or a dash, followed by a space

* Think
- Draw
* Paint
- Ask 
  • Think
  • Draw
  • Paint
  • Ask

Disable special characters preceding it with backslash \

This is \*not bold*

This is *not bold*


End Note: Most of the above can be used with

Select text and click a button at the Post Toolbar'
You can see their keyboard shortcuts hovering the mouse on each button


Now you can't say I didn't know how to format my post contents properly :wink:

11 Likes
Error starting. | Please be more specific
I can't install garuda linux
New-ish Linux User Having Some Issues After new Install
Error mouse and keyboard
Steam driver issue
Dual Boot Garuda & Linux Mint
Error on installing garuda linux
Which version should I choose
Cant get right monitor resolution
FAQ and Tutorials Table of Contents
Change the lock screen layout
Dragonized post installation error
Mic on a 3.5mm combo headset not working
Stuck at load
Accessibility - screen zooming
CS:GO doesn't open
Garuda linux kde is freezing after boot
Boot USB fail?
Installer stuck on logo
Wired Headphone not detecting
Selinux/apparmor
Can't Install Garuda KDE Dragonized Gaming Edition on Ryzen 3800X
Garuda linux got stuck while upgrading garuda-dr490nized
Problem with installing Garuda
Error to Loading Latte (theme problem)
Performance-tweaks and auto-cpufreq-git are in conflict
Usb webcam not working
Nvidia drivers not working at all
Booting Issues v2
Disable power saving mode
Screen tear/flickering and random temporary stutter
Grub Item Not Showing Up
Please tell screen is fluctuating
Hardware error while trying to boot Garuda from USB
Garuda Boot options stuck (Dr460nised KDE)
Each update is a new configuration
Latte dock glitch
Clementine / Icecast help
Grub-Customizer | GrubCFG error line 218
No application can access the microphone
No Audio/Sound after Garuda Install
[SOLVED] Intel Wi-Fi 6 AX200 Wifi - suddenly stops working
Timeshift-autosnap E: JSON data must be UTF-8 encoded
Wired Headphone not detecting
Cannot boot into system
Pen access for the Surface Pro
QTile Edition Fails to Load Config
Need help with Checksum
Intel AX210 Wifi - stopped working after update
My second screen is "disconnected"
Degraded system font quality
Signature from root@pedrohlc.com is unknown trust
Need help with .jar files
KDE Dragonized gaming won't boot from iso to install
Settings often vanishing upon reboot
Can't load a custom edid.bin
New to i3: How do I change the mouse sensitivity?
Bluetooth connection failed: Protocol not available
Sound on LibreWolf (french name) browser disappears
Installation Problem on Dell Inspiron15 7000
25min plus boot times
Garuda logo keeps loading
Cinnamon installer issues, "GUI dim and flickering"
Low framerate desktop experience
Fixing latte top panel
Garuda linux on startup is too buggy
Effects crashing
Kernel Missing due to power fail can only boot using timeshift snapshots now
Gpu drivers problem
Konsole Error with fish
Keyboard crashes in Garuda Installer
Fan Noise and heating
Mounted Partition cant be written
Disk Usage appears too high
Probleme beim Bildschirm teilen
How to install software in Garuda kde multimedia
Unable to boot after installing nvidia proprietary drivers
Pinch to zoom
Apps can move beyond screen resolution
2 monitors full screen mode problem
HDA-NVIDIA-sound-HDMI-laptops-mhwd-nvidia
Weird black bars and buttons while installing kde multimedia
How to set firedragon as default browser
Hdmi for sound not detected
No Booting with Nvidia Drivers
Low memory on Garuda linux along side windows 10
Pacman PGP key error
Meta key shortcut not working
Screen flickering un LXQT-KWIN live USB
Gnome Settings App Removed After Uninstalling Cheese
Chaotic-keyring-20210330-1/desc
Issues with Gnome 40
Displaylink installation fails
Minimal bash-like line editing is supported
Not able to change the color profile
Can't login into Garuda Gnome version
How do i install drivers?
Desktop is empty with no dock or hotbar
Low fps on first workspace and when i move to 2nd workspace it becomes normal
[SOLVED] Broadcom BCM57788 Gigabit capped to 100Mb?