简体中文
English 简体中文 繁體中文
Methodox 首页

在这里试一试!

1. 简介

1.1 Markdown 为什么这么棒 ✨

Markdown 是拥有超能力的纯文本。它让你可以随手记笔记、编写文档、撰写博客文章,甚至排版 PDF——这一切都无需离开你最喜欢的文本编辑器。

  • 对人友好——原始形式就很易读,因此将来的你(以及协作者)可以在任何终端中快速浏览。
  • 可移植——可用于 GitHub、GitLab、Stack Overflow、Jira、Notion,以及无数 CMS 和静态网站生成器。
  • 快速——没有按钮,也没有所见即所得(WYSIWYG)的种种谜团;直接输入即可。
  • 版本控制的福音——因为是纯文本,差异对比(diff)始终清晰干净。

1.2 你会在哪里遇到 Markdown

  • GitHub 上的 README 文件、issue 和 PR 模板。
  • 技术博客(Jekyll、Hugo、Astro 等)。
  • 文档网站(Docsify、MkDocs、Docusaurus)。
  • 笔记应用(Obsidian、Logseq、Typora)。
  • 聊天和社区工具(Telegram、Discord、Slack、Discourse)。

1.3 你可以实现的小奇迹 😍

Markdown 的魔力在于,这些技巧中的每一个在原始文本中依然清晰可读。

奇迹 小片段 效果
任务列表 - [x] done
- [ ] to-do
在 GitHub issue 中显示为可交互的复选框。
语法高亮 ```python
print("Hi")
```
像 IDE 一样着色!
表格 | foo | bar |
|----|----|
整齐对齐的网格。
可折叠块 <details><summary>peek</summary>spoiler!</details> 单击即可揭开秘密。
Emoji I ❤️ Markdown :tada: 变成 😍 🎉。

2 · 快速参考(速查表)

提示: 在 GitHub 上的 .md 文件中试试每个示例,然后单击 Preview(预览)。

2.1 标题

# H1
## H2
### H3

渲染结果 ⇒

展开查看

H1

H2

H3

2.2 强调

*italic*   _italic_
**bold**   __bold__
~~strike~~

italic bold strike

2.3 列表

无序列表

- Item A
  - Sub-item
* Asterisks work too
  • Item A

    • Sub-item
  • Asterisks work too

有序列表

1. First
2. Second
  1. First
  2. Second
[visible text](https://example.com)
<https://example.com>   <!-- autolink -->

visible text https://example.com

2.5 图片

![Alt text](https://picsum.photos/200/300)

Alt text

2.6 代码

行内代码

`code` → code

围栏代码块(带高亮)


```js
function greet() {
  console.log("Hello!");
}
```

2.7 引用块

> One level
>> Nested wisdom

One level

Nested wisdom

2.8 水平线(分隔线)

---

渲染结果 ⇒

展开查看

2.9 表格

| Col A | Col B |
|-------|-------|
|  1    |  2    |
|  3    |  4    |
Col A Col B
1 2
3 4

2.10 任务列表

- [ ] Walk dog
- [x] Write guide
  • Walk dog
  • Write guide

2.11 Emoji

:rocket: :sparkles: :100:

🚀 ✨ 💯

2.12 删除线

~~obsolete~~ now shiny

obsolete now shiny

2.13 行内 HTML(可折叠)

<details>
<summary>Click me</summary>
Surprise! 🎈
</details>
Click me Surprise! 🎈

2.14 转义字符

需要一个字面意义上的 *?使用反斜杠:

\*not italic\*

*not italic*

2.15 脚注

Markdown is handy.[^1]

[^1]: And footnotes are too!

Markdown is handy.1

🎉 大功告成!

现在你已经掌握了 GitHub 风格 Markdown 的要点。把这份速查表放在手边,很快你就能以光速写出排版精美的文档。写作愉快!

探索更多🗺️

要真正精通 Markdown,你应该把它与 HTML 和 CSS 等基础语言的功能结合起来,并利用额外的扩展。更多功能请参阅 Charles 很酷的演示:

  1. HTML
  2. CSS
  3. LaTeX
  4. Mermaid
  5. JavaScript

请注意,取决于渲染器,这些功能不一定在所有地方都受支持。

参考资料


  1. And footnotes are too!↩