Skip to content

Markdown Syntax

FkeMark supports common Markdown syntax and renders most structures close to the final reading result in Live and Read modes.

Quick reference

TypeExampleUsage
Heading# HeadingOrganize article hierarchy
BoldImportantEmphasize keywords
ItalicTermMark tone or terms
StrikeOld textMark deprecated content
Quote> QuoteNotes, excerpts, or tips
Unordered list- ItemSimple lists
Ordered list1. StepStep-by-step flow
Task list- [x] DoneChecklists
LinkTitleReference internal or external material
Image!AltInsert screenshots or images
Inline codeconst name = 'FkeMark'Variables, commands, or short code

Code blocks

Use three tildes or backticks, plus a language name:

md
~~~ts
const mode = 'live'
console.log(mode)
~~~

In the editor, typing ```ts and pressing Enter can also create a code block. Live mode loads syntax highlighting from the language name; choosing text or opening an older plaintext block keeps it plain and saves it as a fence without a language marker.

List line breaks

Keep consecutive list items adjacent; you do not need blank lines between items:

md
- First item
- Second item
- [x] Done

To finish the list and start a new paragraph, keep one blank line after the whole list.

Tables

md
| Mode | Best for |
| --- | --- |
| Live | Daily writing |
| Read | Proofreading |
| Source | Precise editing |

For wide tables, split columns or use smaller tables for better reading.

Front Matter and tags

Use YAML Front Matter at the top of a document for metadata:

md
---
title: Project notes
date: 2026-07-23
tags:
  - markdown
  - fkemark
---

You can also keep lightweight tags in body text with #tag.

Footnotes

md
This needs a note.[^note]

[^note]: This is the footnote content.

Math

Use inline math for short expressions and block math for standalone formulas:

md
Inline: $a^2 + b^2 = c^2$

$$
E = mc^2
$$

Writing tips

  • Keep one level-one heading per document.
  • Use descriptive link text instead of “click here”.
  • Add language names to code blocks for highlighting and search.
  • Write clear image alt text for reading and archiving.

Released under AGPL-3.0-only.