Together C & C++ Wiki Articles

This collection of wiki articles has been developed by the Together C & C++ community.

How to Contribute

Make a PR either adding or modifying a .md file in this folder, or submit an issue about an article.

Wiki Markdown

The articles are written in a GitHub-flavored Markdown. Generally, what you see as a GitHub preview is what you should be getting in the output embed, more or less. However, there are some extra nuances:

Article Title

# Title

A level 1 heading turns into the title of the embed. This will also be used to look up the article in the /wiki or /howto command.

There can be only one level 1 heading in the article, and because it is the title embed, it will always be displayed at the top of the embed, regardless of where the title is located in your markdown.

(Inline) Fields

<!-- inline -->
## Field

Any level 2 heading turns into an embed field. Adding an HTML comment with inline will make it an inline field, which means that it is displayed side-by-side with other inline fields.

Description

Everything after the title, and before the first field is the so-called description of the embed. You can think of it as the "text body". This section is displayed above all fields.

Footers

---
Footer here.

Everything after a footer HTML comment will turn into the footer of the embed. This is a part of the embed at the bottom, displayed with small font.

Links

[text](url)
[tex][ref]

[ref]: url

Inline and reference-style links are supported. On discord the text cannot contain any newlines.

Images

![](https://xyz.xyz/image.png)

Any embed can contain exactly one image. This image is displayed at the bottom of the embed, after any fields.

User Authors

<!-- user author -->

Adding this HTML comment anywhere makes it so that the user who sent the /howto command becomes the "embed author". Their name and avatar will be displayed in the embed.

Aliases

<!-- alias x, y, z -->

This comma-separated list of aliases in an HTML comment will create commands that can be used to display the article, in addition to /howto. The names of the aliases become the name of the commands.

Whitespace and Line Breaks

Just like on GitHub, you can split a paragraph's text over multiple source lines. You can add <br> anywhere to insert a line break, and you can split paragraphs by inserting at least one blank line between them.

Unordered lists (starting with - ), ordered lists (starting with 1.), and code blocks (starting with ```) are treated specially, and don't get merged onto the same line.

Emotes

:fire:
<:stackoverflow:1074747016644661258>

Global Discord emotes like :fire: can be used directly and will display in the embed like they do in your messages. For server-specific emotes, use the format above.

The same applies to channel mentions, role mentions, etc. You can use the app command Apps > Inspect on TCCPP to see how emotes, channel mentions, and other things are formatted, and then copy/paste this into the markdown of your article.

Previewing Wiki Articles

To test out a wiki article use !wiki-preview <entire article content> on the server.

License

The contents of this project are licensed under CC BY-SA