Skip to main content

How to use Markdown (CommonMark) in our wiki

This page is a short “cheat sheet” for formatting pages in our wiki, where content is written in CommonMark Markdown.

Basic rules

  • Write in simple, short sentences.
  • Make the page scannable: headings + lists + tables.
  • One section = one idea. Avoid “walls of text”.

Headings

Use ## / ### / #### for structure.

## Section
### Subsection
#### Sub-subsection

Bold, italic, inline code

**bold**
*italic*
`code/field/address`

If you need to show a “raw” link (rare):

`https://example.com`

Lists

Bulleted list:

- item 1
- item 2
  - sub-item

Numbered list:

1. step 1
2. step 2
3. step 3

Quotes / notes

> This is an important note.
> It can be two lines.

Tables

Minimal template:

| Field | Value |
|---|---|
| Name | [ ] |
| Website | [ ] |

Tips:

  • The separator row |---|---| is required.
  • Table cells can contain **bold**, links, and code.

Code and “raw” text blocks

Code block:

```text
line 1
line 2

If it’s a specific language (for example, JSON), you can specify it:

```markdown
```json
{ "key": "value" }

## Images

If you have a direct image URL:

```markdown
![description](https://example.com/image.png)

If the file is uploaded to the wiki, use the link/embed that the wiki provides on upload.

Line breaks and paragraphs

  • A new paragraph is a blank line between paragraphs.
  • If you need a line break within a paragraph, add two spaces at the end of the line:
First line.␠␠
Second line.

Embedded HTML (use with care)

Collapsible “Details” block

Use it for long details/evidence to avoid overloading the “first screen”.

<details>
<summary><b>Details</b></summary>

You can put text, lists, and tables here.

</details>

Anchors and quick links within a page

Anchor:

<a id="ai-thesis-fit"></a>
[Jump to AI thesis fit](#ai-thesis-fit)

Placeholders in templates

In templates we use:

  • [ ] — “fill in”
  • unknown / — “unknown / not applicable” (when meaningful)
  • YYYY‑MM‑DD — date format
  • Tier‑1/2/3 — source tier (evidence/context/noise)

Common mistakes

  • Mixing infobox and description: the infobox is short facts only; explanations go in the page body.
  • Writing without sources where a source should exist.
  • Overloading the “first screen”: long details are better placed inside <details>.
  • Using “financial language” (buy/sell/hold advice, forecasts) — it’s forbidden for us; we write facts/risks/what to verify.

Mini checklist before publishing

  • Are there 1–2 lines that explain “what it is”?
  • Are there links to primary sources?
  • Are there any empty “unclear” table fields (each is either a value or unknown/—)?
  • Is Last verified filled in?