# Discourse Tips and Tricks

**URL:** <https://hellominers.com/t/discourse-tips-and-tricks/25070>\
**Category:** Community\
**Tags:** guide, document\
**Created:** [August 23, 2023, 5:59am UTC](https://hellominers.com/t/discourse-tips-and-tricks/25070 "2023-08-23T05:59:56Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![Luc](https://hellominers.com/user_avatar/hellominers.com/luc/32/1861_2.png) [@Luc](https://hellominers.com/u/Luc)\
**Post date:** [August 23, 2023, 5:59am UTC](https://hellominers.com/t/discourse-tips-and-tricks/25070/1 "2023-08-23T05:59:56Z")

</div>

# Introduction

This guide outlines some tips and tricks for using the discourse topic creation tools and functions. How to style the content of your posts, and how to use some of the added features on our forum.

This guide has many sections for the styling copied from this [guidebook](https://forum.digikey.com/t/an-unofficial-discourse-user-reference-guide/1125) I found, I figured others may find it useful as well.

* * *

# Discourse Documents Page

The discourse documents plugin was recently added to the forums. This plugin adds a new page, seen below and at [https://play.hellominers.com:54321/docs](https://play.hellominers.com:54321/docs) where you can view and easily filter through any post that has been created using the correct tags for docs.

 ![image](https://hellominers.com/uploads/default/original/2X/3/3a561fb90e80dde6bab657669673076a213c2255.jpeg)

I have converted a few posts already to use the correct tags for documents, just to show what it will look like.

## Document Tags

When creating your document post, you must add the `document` tag to your post, as well as any relevant sub-tags for documents. All tags available for documents can be fount at [https://play.hellominers.com:54321/tags](https://play.hellominers.com:54321/tags). If you would like a specific tag added to the list, please contact an admin.

Tags can be added in the following spot in your post editor:

 ![image](https://hellominers.com/uploads/default/original/2X/5/526ac2cd50b0b43ff2de5f91663dbac1821ca7fc.png)

* * *

# Styling

This is a “quick” how-to guide for using [Discourse](https://www.discourse.org/) forum/community software. It contains a majority of the common features avialble to users/content editors, but may not have complete coverage of the featureset. If anyone sees anything to add or correct, feel free to comment. If you’d like to learn more about the Discourse Editor’s syntax take a look at the [commonmark](http://commonmark.org/help/) (a flavor of markdown) docs for more info.

## Links

Most of the time you’d want to use the editor bar or hotkey crtl+k, but the basic format is `[link text](https://play.hellominers.com:54321)` which will give you an example link that looks like this: [link text](https://play.hellominers.com:54321)

> **Note - Easier Editing with Links**  
> Having long URLs intermingled in your editor can sometimes make it a pain so you can also offset the links using the syntax in the example below. Note you must have a blank line above the reference and the reference id can be any number, text, or punctuation.

```auto
This paragraph is much easier to read in the [editor][1] because you can 
[include][hmlink] the links below the paragraph text or at the bottom of the page.
 
[1]: https://play.hellominers.com:54321
[hmlink]: https://play.hellominers.com:54321/t/hellominers-community-rules/23470

```

This paragraph is much easier to read in the [editor](https://play.hellominers.com:54321) because you can [include](https://play.hellominers.com:54321/t/hellominers-community-rules/23470) the links below the paragraph text or at the bottom of the page.

### Images

Adding images is quite easy, if there’s an image in your clipboard, just paste it in, the forum will automatically upload the image and fill in the appropriate syntax to make the image appear. If you are linking an image which is already on the web, use the following syntax. `![title text](upload://nkS6YJtphuqVclV9DQErztgIEpR.png)` Result:

 ![title text](https://hellominers.com/uploads/default/original/2X/a/a38e062101ab00e7870b5a245f1671074cf9e223.png)

##### Image Sizing

If you would like to resize a large image to a smaller image use the following syntax.

```auto
![Original|200x200](upload://nkS6YJtphuqVclV9DQErztgIEpR.png)
![Percent|200x200, 50%](upload://nkS6YJtphuqVclV9DQErztgIEpR.png)
![By Pixels|64x64](upload://nkS6YJtphuqVclV9DQErztgIEpR.png)

```

Original

 ![logo](https://hellominers.com/uploads/default/original/2X/a/a38e062101ab00e7870b5a245f1671074cf9e223.png) Resized 50% ![logo](https://hellominers.com/uploads/default/original/2X/a/a38e062101ab00e7870b5a245f1671074cf9e223.png) By Pixels ![logo](https://hellominers.com/uploads/default/original/2X/a/a38e062101ab00e7870b5a245f1671074cf9e223.png)

### Text Formatting

For bold, italics and strike-through use the editor buttons ![image](https://hellominers.com/uploads/default/original/2X/3/3e4969b586310735a416f84ef52fd44b866c01bb.png)or directly type the markdown:

```auto
**bold word** or __bold word__
*italicized word* or _italicized word_
_combo of **bold** and **italic** _
~~strike-through word~~

```

**bold word** or **bold word**  
_italicized word_ or _italicized word_  
_combo of **bold** and **italic** _  
~~strike-through word~~

Alternatively, there’s some BBCode sytnax that a person can use  
`[b]like this[/b]` like this  
`[i]or this[/i]` or this  
`[u]underline[/u]` underline

Font color is not natively supported, but there is a BBCode plugin that will allow for changes in font color.  
One can also have some choice to change fonts or colors using the LaTeX-based mathjax plugin covered in the mathjax section of this guide. `$\color{red}{red text}$` redtext

## Headings

```auto
# H1
## H2
### H3
#### H4
##### H5
###### H6

horizontal rule is 3+ asterisks
***

```

 ![image](https://hellominers.com/uploads/default/original/2X/4/455bd42c141468ddc5bf04c921e1dd9bd2bbc27e.png)

_horizontal rule_

* * *

### Lists

You can use the editor buttons for ordered ![image_2023-08-23_013413048](https://hellominers.com/uploads/default/original/2X/a/a4ad1c6f1c8a848a95b6e3dd1e35243129fb2e8a.png) or unordered ![image_2023-08-23_013538410](https://hellominers.com/uploads/default/original/2X/6/6c015b4aa4b78e998f865d398dfeb258547b11d9.png) lists.

```auto
1. First ordered list item
2. second list item
   * sub-lists are offset by three spaces      
1. Specific numbers 
1. don't matter they will auto increment
1. auto increment

* unordered lists 
* are also possible

```

1. First ordered list item
2. Explicit second list item

- sub-lists are offset by three spaces

1. Specific numbers
2. don’t matter they will auto increment
3. auto increment

- unordered lists
- are also possible

### Code Formatting

#### Inline code formatting

Surround a section of code with backticks (`) inline code formatting. **Typing:** `var x = 10;` **Results in:** `var x = 10;`This can also be done as`var x = 10;` inline.

Present entire line as code by prefixing four (4) spaces (an extra newline before this)  
**Typing** :

```auto
 var this = “is a line”;

```

**Results in :**

```auto
var this = "is a line";

```

#### Multi-Line Blocks of Code

Surrounding code with three backticks ``` will allow for code to span multiple lines  
**Typing:**

```auto
function foo(bar){
return bar+1;
}

```

**Results in:**

```auto
function foo(bar){
    return bar+1;
}

```

#### Syntax Highlighting

The code block will try to automatically choose a style for code, but you can explicitly call out the desired formatting.

```auto
function foo(bar){
return bar+1;
}

```

**Results in:**

```auto
function foo(bar){
    return bar+1;
}

```

### Tables

Tables are second class citizens in Discourse, some of the formatting features and niceties work and some don’t.

> **Protip -** The easiest way to get a table into discourse is to start a table in an spreadsheet, then copy & paste that table into the editor window. Discourse natively handles the format change and makes creating a table much easier. Excel and Google Sheets work great using this method.

A markdown table in Discourse needs at least the first two lines to exist:

```auto
|Color|Weight|Height|
|-|-|-|
|red|12|160|
|green|4|100|

```

| Color | Weight | Height |
| --- | --- | --- |
| red | 12 | 160 |
| green | 4 | 100 |

You can also use **HTML for tables**.

```auto
<table>
  <tr>
    <th>Color</th>
    <th>Weight</th>
    <th>Height</th>
  </tr>
  <tr>
    <td>red</td>
    <td>12</td>
    <td>160</td>
  </tr>
  <tr>
    <td>green</td>
    <td>4</td>
    <td>100</td>
  </tr>
</table>

```

| Color | Weight | Height |
| --- | --- | --- |
| red | 12 | 160 |
| green | 4 | 100 |

## Blockquotes

Blockquotes can be found in the editor bar button ![image_2023-08-23_013747910](https://hellominers.com/uploads/default/original/2X/6/6cbb47eb6a9230f034a983c2bd180bab26266f21.png)  
Puting a greater than sign \> in front of so a line will create blockquotes  
**Typing:**

> this is some blockquoted text  
> this is another line of blockquoted text

this is not blockquoted

> this is another one  
> **Results in:**

> this is some blockquoted text  
> this is another line of blockquoted text

this is not blockquoted

> this is another one

## Table of Contents

### Manual Method

The manual method of creating a table of contents within the body of your topic can be found below:

```auto
* [link to first heading](https://play.hellominers.com:54321/t/discourse-tips-and-tricks/25070#first-one-16)
* [link to second heading](https://play.hellominers.com:54321/t/discourse-tips-and-tricks/25070#second-one-17)
* [link to third heading](https://play.hellominers.com:54321/t/discourse-tips-and-tricks/25070#third-one-18)
* [link to fourth heading](https://play.hellominers.com:54321/t/discourse-tips-and-tricks/25070#fourth-one-19)

```

which results in:

- [link to first heading](https://play.hellominers.com:54321/t/discourse-tips-and-tricks/25070#first-one-16)
- [link to second heading](https://play.hellominers.com:54321/t/discourse-tips-and-tricks/25070#second-one-17)
- [link to third heading](https://play.hellominers.com:54321/t/discourse-tips-and-tricks/25070#third-one-18)
- [link to fourth heading](https://play.hellominers.com:54321/t/discourse-tips-and-tricks/25070#fourth-one-19)

#### First One

some text

#### Second One

more text

#### Third One

even more text

#### Fourth One

ok no more text

### Plugin Method

You can create a table of contents automatically thanks to the table of contents plugin. You can create it by selecting the following in the body text box banner:

 ![image_2023-08-23_014919426](https://hellominers.com/uploads/default/original/2X/d/dac337dc380631b6fd2b7dcff7a3377b0e9c899e.png)

Make sure this `<div>` is on the first line of the post _and_ there is an empty line between it and your content.

```auto
<div data-theme-toc="true"> </div>

# Introduction

```

You’ll know it is configured correctly if you see this

 ![image](https://hellominers.com/uploads/default/original/2X/5/5a62e27c34926f62fa5fc91696f92c1a87aefd5b.png)

* * *

# Images

It is possible to upload images to Discourse; however, the preference is that users will host from a site like imgur. If you can host it elsewhere, please do.

* * *

# Community Events Post Guide

Check out the [Events Category](https://play.hellominers.com:54321/c/community/comunity-events/l/calendar) to see a calendar of upcoming community events! Players can submit events for approval here.

## How to create an event topic:

1. Select the New Topic button highlighted with a green box.  

2. Fill out the title and description with details of the event as usual.

3. Select the Calendar “Add Event” Button highlighted with a green box.  

4. Fill out the calendar setting the date and start/end times, and select done.  

5. Select the create topic button to submit for approval. Once submitted, let a staff member know and they will review and approve the post, adding it to the calendar.