Skip to content

Instantly share code, notes, and snippets.

@duncte123

duncte123/Oengus Markdown.md

Created September 23, 2024 09:54
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save duncte123/694b5d2ea1273fe468718a2b42dda130 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save duncte123/694b5d2ea1273fe468718a2b42dda130 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. duncte123 created this gist Sep 23, 2024.
    86 changes: 86 additions & 0 deletions Oengus Markdown.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,86 @@
    Oengus allows for markdown in a few places. This document serves as a guide and a cheat sheet in case you ever need help.
    Markdown on oengus is split into two sections, simple and advanced. Simple markdown is used for schedule runs, this only allows a few things.
    Advanced markdown allows pretty much everything!

    # Simple markdown (schedules)
    Schedule lines, reffered to as "runs" in the UI, only allow very basic markdown in the runner, game and category fields.
    This markdown is as follows:

    - `**bold text**` => **bold text**
    - `_italicised text_` => _italicised text_
    - `[Named links](https://oengus.io)` => [Named links](https://oengus.io)
    - `[Named links](https://oengus.io "With optional hover text")` => [Named links](https://oengus.io "With optional hover text")

    # Advanced markdown (marathon description)
    Advanced markdown supports all the basic syntax detailed on https://www.markdownguide.org/basic-syntax/ but it also supports some extras!

    Missing a markdown feature on Oengus? [Feel free to make an issue on github about it](https://github.com/oengusio/oengusio/issues/new/choose)!

    ## Markdown 101
    Please read the [basic syntax](https://www.markdownguide.org/basic-syntax/) guide, it contains a lot of useful info!

    ## Emojis
    Oengus can convert text emojis to their unicode variants. An example of this is `:wave:` converting to :wave: (kinda like discord and [GFM](https://github.github.com/gfm/)!)

    ## Tables
    Oengus supports markdown tables, they are not very responsive so use them with caution

    | Syntax | Description |
    | ----------- | ----------- |
    | Header | Title |
    | Paragraph | Text |

    The syntax looks like this:
    ```markdown

    | Syntax | Description |
    | ----------- | ----------- |
    | Header | Title |
    | Paragraph | Text |
    ```


    # Alerts
    Just like GFM, oengus supports alerts via the [alerts markdown extension](https://github.com/antfu/markdown-it-github-alerts), they look like the github ones.

    > [!NOTE]
    > Highlights information that users should take into account, even when skimming.
    > [!TIP]
    > Optional information to help a user be more successful.
    > [!IMPORTANT]
    > Crucial information necessary for users to succeed.
    > [!WARNING]
    > Critical content demanding immediate user attention due to potential risks.
    > [!CAUTION]
    > Negative potential consequences of an action.
    The syntax for that is as follows:
    ```markdown
    > [!NOTE]
    > Highlights information that users should take into account, even when skimming.

    > [!TIP]
    > Optional information to help a user be more successful.

    > [!IMPORTANT]
    > Crucial information necessary for users to succeed.

    > [!WARNING]
    > Critical content demanding immediate user attention due to potential risks.

    > [!CAUTION]
    > Negative potential consequences of an action.
    ```

    Not supported by github (so I can't easily preview it here without using images), but you can also put custom text in the header on oengus!

    ```markdown
    > [!TIP] Did you know?
    > You can even put custom text in the header!
    ```