Discourse style guide

This style guide demonstrates the formatting capabilities of this Discourse. It is a reference for users to learn what they can pull off in their posts, and for our staff to refer to when tweaking our stylesheets.


Headings

Second level heading

Third level heading

Fourth level heading

Fifth level heading
Sixth level heading

Formatting

Type

Bold

Italic

Strike-through

A link

Ins tag

Del tag

Lists

Ordered lists

  1. There was a young fellow named Hall
  2. Who fell in the spring in the fall.
  3. 'Twould have been a sad thing
  4. Had he died in the spring,
  5. But he didn’t - he died in the fall.

And then the spacier version:

  1. There was a young fellow named Hall

  2. Who fell in the spring in the fall.

  3. 'Twould have been a sad thing

  4. Had he died in the spring,

  5. But he didn’t - he died in the fall.

Unordered lists

  • The bottle of scent Willie sent
    • Was quite displeasing to Millicent.
    • Her thanks were so cold
  • That they quarreled, I’m told,
    • 'Bout that silly scent Willie sent Millicent.

And then the spacier version:

  • The bottle of scent Willie sent

    • Was quite displeasing to Millicent.
    • Her thanks were so cold
  • That they quarreled, I’m told,

    • 'Bout that silly scent Willie sent Millicent.

Blockquotes

This is a test quote.

It supports

Headings

Of various levels

Tada

It never ends

Aaaaaaaaaaaaa
Ded

Even other blockquotes!

Shazzam?

Code

There’s inline code, and code blocks:

(progn
  (message "For the belt")
  (message "Beltalowda"))

And again, in block quotes

There’s inline code, and code blocks:

(progn
  (message "For the belt")
  (message "Beltalowda"))

Key sequences

  • Help keys: C-hv
  • Leader keys: SPCpf

In blockquotes

  • Help keys: C-hv
  • Leader keys: SPCpf

Unique

These features were implemented specifically for our Discourse.

Local abbreviations

You may have noticed some abbreviations and words are underlined, such as:

  • iirc
  • afaik
  • [localleader]

Mousing over these will momentarily display their meaning in a popup.

These are globally defined by the admins of this discourse, but post-specific abbreviations can also be defined:

The HTML specification
is maintained by the W3C,
And so is the XHTML specification.

*[HTML]: Hyper Text Markup Language
*[W3C]:  World Wide Web Consortium

The HTML specification is maintained by the W3C, And so is the XHTML specification.

Tabbed sections

Simple panels

(map! "C-c C-c" #'dosomething)
(define-key global-map (kbd "C-c C-c") #'dosomething)
(define-key global-map (kbd "C-c C-x") #'dosomething)

A quote from a famous person.

A tutor who tooted a flute,

Tried to teach two young tooters to toot.

Said the two to the tutor,

“Is it harder to toot, or …

To tutor two tooters to toot?”

Toot toot

(define-key global-map (kbd "C-c C-c") #'dosomething)
(define-key global-map (kbd "C-c C-x") #'dosomething)
(progn
  (message "For the belt")
  (message "Beltalowda"))
Show source
[tabs]
[tab title="highlighted code block"]
```lisp
(map! "C-c C-c" #'dosomething)
```
[/tab]
[tab title="unhighlighted code block"]
```
(define-key global-map (kbd "C-c C-c") #'dosomething)
(define-key global-map (kbd "C-c C-x") #'dosomething)
```
[/tab]
[tab title="blockquote"]
> A quote from a famous person.
[/tab]
[/tabs]
[tabs]
[tab=longform1]
A tutor who tooted a flute,

Tried to *teach* two young tooters to toot.

Said the two to the **tutor**,

“Is it harder to toot, or ...

To tutor two tooters to toot?”

> Toot toot
[/tab]
[tab id=longform2 title="Long form #2"]
```lisp
(define-key global-map (kbd "C-c C-c") #'dosomething)
(define-key global-map (kbd "C-c C-x") #'dosomething)
```

```lisp
(progn
  (message "For the belt")
  (message "Beltalowda"))
```
[/tab]
[/tabs]

DISABLED Global panels

This is different from simple panels in that the tabs are detached from the elements they alter (and you can have multiple).

[tab=evil title=“For evil users”][/tab]

[tab=vanilla title=“For vanilla users”][/tab]

This is for evil users!

This is for vanilla users!

This is also for evil users!

This is also for vanilla users!

Show source
[tabs id=global]
[tab id=evil title="For evil users"][/tab]
[tab id=vanilla title="For vanilla users"][/tab]
[/tabs]

...

[tab=evil]This is for evil users![/tab]
[tab=vanilla]This is for vanilla users![/tab]

[tab=evil]This is also for evil users![/tab]
[tab=vanilla]This is also for vanilla users![/tab]

Notices

:pushpin: These notices are for helpful tidbits and extra details.

:clock2: These are for temporary/time-sensitive notes that may be removed or changed soon.

:thought_balloon: These are for author ramblings, thoughts, and opinions.

:warning: These are for warnings and gotchas that users should know about.

:doomgod: You can use any emoji to create a notice, though I ask you to only use the ones above for consistency’s sake.

Show source
[notice]
:pushpin: These notices are for helpful tidbits and extra details.
[/notice]

[notice]
:clock2: These are for temporary/time-sensitive notes that may be removed or changed soon.
[/notice]

[notice]
:thought_balloon: These are for author ramblings, thoughts, and opinions.
[/notice]

[notice]
:warning: These are for warnings and gotchas that users should know about.
[/notice]

[notice]
:doomgod: You can use any emoji to create a notice, though I ask you to only use the ones above for consistency's sake.
[/notice]

Floating

This is floated left

This is floated right

{This paragraph is cleared and mustn’t be empty. Even a single space will do}

Show source
[float=left]
This is floated left
[/float]

[float=right]
This is floated right
[/float]

[clear]{This paragraph is cleared and mustn't be empty. Even a single space will do}[/clear]

Obfuscated Text Dump

With [dump][/dump] tags you can hide a region of text from being indexed by our search engine (or Google). Text within will be displayed as a pre-formatted code block, but is populated on the client-side:


Loading data dump...

This was written specifically for M-x doom/info and log/backtrace text dumps, which are likely to pollute search results.

Show source
[dump]
The search engine won't index this!
[/dump]

Inline footnotes

Here is a footnote reference,[1] and another.[2]

Show source
Here is a footnote reference,[^1] and another.[^longnote]

[^1]: Here is the footnote.

[^longnote]: Here's one with multiple blocks.

    Subsequent paragraphs are indented to show that they
belong to the previous footnote.

    + Nested lists are okay too
    + And so on
    + And so forth

Simpler key sequences

A succinct syntax for keybinds: [kbd command=X alt="A,B,C"]...[/kbd]

  • SPChdm

  • SPCbb

  • [leader]hdm

Show source
- [kbd]SPC h d m[/kbd]

- [kbd command=switch-to-buffer alt="SPC b b,C-x b"]SPC <[/kbd]

- [kbd][leader] h d m[/kbd]

:pushpin: Some strings are automatically wrapped in abbr tags, such as [leader] and [localleader].

:pushpin: Currently, this bbcode tag is only syntax sugar for kbd tags, but will be improved later.

Spoiler tags

This is a spoiler, and will be obscured until it is clicked.

Show source
This [spoiler]is a spoiler[/spoiler], and will be obscured until it is clicked.

Image galleries

image image image

For some reason, however:

  • Images must exceed 500x690 for this to work.
  • Galleries must have a paragraph after them.

(More examples)

Show source
<div data-theme-slick="1">

![image|508x500](upload://5TvRqXrLpc2Pilqq6FbyIDjvw9r.jpeg)
![image|503x500](upload://bcAsnNGG2ijv04eiFi0gJOeYXAo.jpeg)
![image|506x500](upload://odKceyCOdICCbAlvO9pTFHENTXf.jpeg)

</div>

  1. Here is the footnote. ↩︎

  2. Here’s one with multiple blocks.

    Subsequent paragraphs are indented to show that they belong to the previous footnote.

    • Nested lists are okay too
    • And so on
    • And so forth
    ↩︎
3 Likes