Styleguide for Wiki Pages

Styleguide for Wikipages

Headinglevel and Headlines

The first Headline must be the Title from the Wikipage and should have # as Headinglevel. Other Headline sould have ## as Headinglevel or ### if it is a sub-Healine from the ##. And headlines should not be numbered.

Outdated and Pre-Release content

The outdated and pre-release content should be marked with "> [emoji] ** [Title] **" at the beginning of the site.
Examples:

❌ Outdated

⚠️ Pre-Release Content

Note content

Like the outdated and pre-release content it should be marked with "> 💡 ** Note: **".
Example:

💡 Note: Here is an example for a Note

TODO content

Like the above it should be marked with "> 👨‍🔧 ** TODO **".
Example:

👨‍🔧 TODO Here is an example for a Note

Engine Developer content

Like the outdated and pre-release content it should be marked with "## 👷 Engine Developer".
Example:

👷 Engine Developer

Downloadable files

If you want to link a file for download, it should be placed in the Files folder in the Wiki, if it is a self-made file. Important is when it's linked it must be as an absolute link. And should marked with "> 📥"

📥

Step-by-Step instructions

If step-by-step instructions are required, these should be done using bullet lists.
Example:

• Step 1
• Step 2
• Step 3

Rules for "In this Article"

Don't create your own table of contents and use the headlines.

Code snippets

If you add code snippets they should start with ```csharp. for other information like Path or Commands it should be `` with the information between the two.

Examples:

Console.log("helloWorld");

C:/User dotnet tool install -g Fusee.Tools.CmdLine