88 lines
No EOL
2.1 KiB
Markdown
88 lines
No EOL
2.1 KiB
Markdown
thumb: https://picsum.photos/id/237/200/300
|
|
title: Comprehensive Markdown & GFM Syntax Reference
|
|
desc: A detailed guide to Markdown and GitHub Flavored Markdown (GFM) syntax, covering text formatting, lists, tables, code blocks, links, and footnotes.
|
|
date: 2026-05-27
|
|
tags: [markdown, gfm, syntax, reference, guide]
|
|
draft: true
|
|
^---
|
|
|
|
## 1. Text Formatting & Structure
|
|
|
|
* **Bold:** **This text is bold** or __this is bold__.
|
|
* **Italic:** *This text is italic* or _this is italic_.
|
|
* **Strikethrough (GFM):** ~~This text is crossed out.~~
|
|
* **Combined:** ***This text is bold and italic***.
|
|
* **Inline Code:** Use single backticks for `console.log("Hello World")` inline.
|
|
|
|
### Hierarchy Example
|
|
> **Blockquotes:** Use blockquotes to highlight quotes, notes, or warnings.
|
|
>
|
|
> "The best way to predict the future is to invent it."
|
|
> > Nested blockquotes are supported by adding an extra `>`.
|
|
|
|
---
|
|
|
|
## 2. Lists
|
|
|
|
### Unordered (Bulleted)
|
|
* Item 1
|
|
* Nested Item 1.1
|
|
* Nested Item 1.2
|
|
* Item 2
|
|
|
|
### Ordered (Numbered)
|
|
1. First item
|
|
2. Second item
|
|
1. Nested ordered item
|
|
2. Another nested item
|
|
3. Third item
|
|
|
|
### Task Lists (GFM)
|
|
- [x] Write the Markdown test template
|
|
- [ ] Implement features in production
|
|
- [ ] Review documentation
|
|
|
|
---
|
|
|
|
## 3. Tables (GFM)
|
|
|
|
| Feature | Standard Markdown | GFM Extension | Status |
|
|
| :--- | :---: | :---: | ---: |
|
|
| Tables | ✗ | ✓ | Implemented |
|
|
| Task Lists | ✗ | ✓ | Implemented |
|
|
| Autolinks | ✗ | ✓ | Native |
|
|
| Strikethrough | ✗ | ✓ | Implemented |
|
|
|
|
---
|
|
|
|
## 4. Code Blocks with Syntax Highlighting
|
|
|
|
```nix
|
|
{ config, pkgs, ... }:
|
|
|
|
{
|
|
environment.systemPackages = with pkgs; [
|
|
git
|
|
neovim
|
|
tmux
|
|
];
|
|
|
|
nix.settings.experimental-features = [ "nix-command" "flakes" ];
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## 5. Links and Autolinks
|
|
|
|
* **Standard Link:** [Search Engine](https://www.google.com)
|
|
* **Link with Tooltip:** [GitHub](https://github.com "Go to GitHub")
|
|
* **Autolink (GFM):** https://nixos.org
|
|
|
|
---
|
|
|
|
## 6. Footnotes (GFM)
|
|
|
|
You can reference a footnote at the end of a sentence[^1].
|
|
|
|
[^1]: This is the text of the footnote, which typically renders at the bottom of the document. |