Headings
The number of # at the start of a line sets the level. Headings also appear in the Outline.
# Heading 1## Heading 2### Heading 3Guide
The Markdown syntax Marxdown can show. The source is on the left and the result on the right.
Marxdown follows CommonMark. Write as you would on GitHub, and it looks the same.
The number of # at the start of a line sets the level. Headings also appear in the Outline.
# Heading 1## Heading 2### Heading 3Separate paragraphs with a blank line. By default, line breaks inside a paragraph are joined. End a line with two spaces or \ to break it. Turn on “Keep Line Breaks in Paragraphs” in Settings to keep every line break.
This is the first paragraph.This line joins the previous one.This is the second paragraph.\This starts a new line.This is the first paragraph. This line joins the previous one.
This is the second paragraph.
This starts a new line.
In the editor, toggle them with Ctrl+B (bold), Ctrl+I (italic), and Ctrl+Shift+X (strikethrough).
**Bold**, *italic*, ~~strikethrough~~, `inline code`Bold, italic, strikethrough, inline code
Start a line with - or a number. Indent to nest. In the editor, Tab and Shift+Tab indent and outdent.
- Apples- Oranges - Mandarin - Navel1. Read2. Write3. Savehttp(s) links open in your default browser. Relative links to .md files open inside Marxdown. Images inside the folder of the opened file are shown.
[The Marxdown repository](https://github.com/antimacho612/marxdown)[Design notes](./docs/design.md)Start a line with >. In the editor, toggle it with Ctrl+Shift+.
> Readability you can adjust.>> > Quotes can be nested.Readability you can adjust.
Quotes can be nested.
Fence code with ``` and add a language name for syntax highlighting. Supported: Bash, C, C++, C#, CSS, Diff, Go, INI / TOML, Java, JavaScript, JSON, Markdown, Python, Rust, SQL, TypeScript, HTML / XML, and YAML.
```rustfn main() { let name = "Marxdown"; println!("Hello, {name}!");}```fn main() {
let name = "Marxdown";
println!("Hello, {name}!");
}
A line with only --- becomes a horizontal rule.
One topic---Another topicOne topic
Another topic
You can write HTML. Scripts and event attributes like onclick are removed and never run.
<details><summary>Click to open</summary>This was folded.</details>Save with <kbd>Ctrl</kbd>+<kbd>S</kbd>This was folded.
Save with Ctrl+S
GitHub Flavored Markdown extensions and GitHub alerts are supported.
The position of : in the second row sets the alignment. In the editor, Tab moves to the next cell and Shift+Alt+F aligns the columns. Choose how borders are drawn with “Table Borders” in Settings.
| Strategy | p95 | Cost || :--- | ---: | :---: || No cache | 240ms | Low || TTL | 22ms | Low || Stale-While-Revalidate | 18ms | Medium || Strategy | p95 | Cost |
|---|---|---|
| No cache | 240ms | Low |
| TTL | 22ms | Low |
| Stale-While-Revalidate | 18ms | Medium |
In the editor, Ctrl+Enter toggles the check.
- [x] Compare strategies- [ ] Add expiry metrics- [ ] Load testingURLs become links as they are.
Repository: https://github.com/antimacho612/marxdownRepository: https://github.com/antimacho612/marxdown
The same five kinds as GitHub.
> [!NOTE]> Useful information.> [!TIP]> Helpful advice.> [!IMPORTANT]> Key information.> [!WARNING]> Needs attention.> [!CAUTION]> Risky consequences.Note
Useful information.
Tip
Helpful advice.
Important
Key information.
Warning
Needs attention.
Caution
Risky consequences.
Footnotes are collected at the end of the document.
Wrap with $ for inline math, or $$ for a block, rendered with KaTeX. Amounts like $5 and $10 do not become math.
The mean latency is about $\bar{t} = h \cdot t_c + (1 - h) \cdot t_m$.$$\sum_{k=1}^{n} k = \frac{n(n+1)}{2}$$The mean latency is about .
A mermaid code block is shown as a diagram. Flowcharts, sequence diagrams, Gantt charts, and every other Mermaid diagram work.
```mermaidsequenceDiagram Terminal->>Marxdown: marxdown README.md Marxdown-->>Terminal: Prompt returns right away Marxdown->>Marxdown: Open as a tab```YAML fenced with --- at the top is shown as a table, apart from the body. Use “Front Matter” in Settings to show it as YAML or hide it.
---title: Design notestags: [cache, api]---# Design notes| title | Design notes |
|---|---|
| tags |
Put marp: true in the front matter to show the document as Marp slides. Separate slides with ---. Load your own themes with “Marp Themes” in Settings.
---marp: truetheme: defaultpaginate: true---# Caching strategyLowering the p95 of the search API---## DecisionAdopt Stale-While-RevalidateShown as slides, one at a time.
Non-standard syntax. To keep your documents from changing unexpectedly, all of them are off by default. Turn them on one by one in the Syntax section of Settings.
markdown.marksShows ==text== as if marked with a highlighter.
The answer is ==Stale-While-Revalidate==.The answer is Stale-While-Revalidate.
markdown.insertionsShows ++text++ underlined, as inserted text.
The p95 is now ++18ms++.The p95 is now 18ms.
markdown.superscriptShows text wrapped in ^ as superscript.
E = mc^2^E = mc2
markdown.subscriptShows text wrapped in ~ as subscript.
H~2~OH2O
markdown.definitionListsStart the line after a term with : to make a definition list.
TTL: Expires entries after a fixed timeStale-While-Revalidate: Returns the stale response while refreshing in the backgroundmarkdown.abbreviationsWords defined as *[ABBR]: Description show the description on hover.
CSP restricts what can be loaded.*[CSP]: Content Security PolicyCSP restricts what can be loaded.
markdown.multilineTablesPut \ after the last | of a row to continue the same cells on the next line. The continued lines are read together as Markdown, so a cell can hold a list. A cell containing ^^ merges with the cell above it.
| Strategy | Traits | Cost || --- | --- | --- || TTL | - Expires after a fixed time | Low |\| | - Easy to build | || No cache | Always fresh | ^^ || SWR | Returns stale data while refreshing | Medium || Strategy | Traits | Cost |
|---|---|---|
|
TTL |
|
Low |
| No cache | Always fresh | |
| SWR | Returns stale data while refreshing | Medium |