Mastering Markdown

本文介绍了一种简单易用的文本格式化语法——Markdown。它使你在GitHub平台上进行协作编辑变得轻松便捷。文章详细阐述了Markdown的基本使用方法,包括粗体、斜体、链接、列表等常见格式的设置,并展示了GitHub如何自动渲染Markdown内容。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

转: https://guides.github.com/features/mastering-markdown/#examples


Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.

What you will learn:

  • How the Markdown format makes styled collaborative editing easy
  • How Markdown differs from traditional formatting approaches
  • How to use Markdown to format text
  • How to leverage GitHub’s automatic Markdown rendering
  • How to apply GitHub’s unique Markdown extensions

What is Markdown?

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

You can use Markdown most places around GitHub:

  • Gists
  • Comments in Issues and Pull Requests
  • Files with the .md or .markdown extension

Examples

It's very easy to make some words **bold** and other words *italic* with Markdown. You can even [link to Google!](http://google.com)
It's very easy to make some words  bold and other words  italic with Markdown. You can even  link to Google!

Syntax guide

Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.

Headers

# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag

Emphasis

*This text will be italic*
_This will also be italic_

**This text will be bold**
__This will also be bold__

_You **can** combine them_

Lists

Unordered
* Item 1
* Item 2
  * Item 2a
  * Item 2b
Ordered
1. Item 1
2. Item 2
3. Item 3
   * Item 3a
   * Item 3b

Images

![GitHub Logo](/images/logo.png)
Format: ![Alt Text](url)

Links

http://github.com - automatic!
[GitHub](http://github.com)

Blockquotes

As Kanye West said:

> We're living the future so
> the present is our past.

Inline code

I think you should use an
`<addr>` element here instead.

GitHub Flavored Markdown

GitHub.com uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com.

Note that some features of GitHub Flavored Markdown are only available in the descriptions and comments of Issues and Pull Requests. These include @mentions as well as references to SHA-1 hashes, Issues, and Pull Requests. Task Lists are also available in Gist comments and in Gist Markdown files.

Syntax highlighting

Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:

```javascript
function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}
```

You can also simply indent your code by four spaces:

    function fancyAlert(arg) {
      if(arg) {
        $.facebox({div:'#foo'})
      }
    }

Here’s an example of Python code without syntax highlighting:

def foo():
    if not bar:
        return True

Task Lists

- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item

If you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list. It also works in Pull Requests!

Tables

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

Would become:

First HeaderSecond Header
Content from cell 1Content from cell 2
Content in the first columnContent in the second column

SHA references

Any reference to a commit’s SHA-1 hash will be automatically converted into a link to that commit on GitHub.

16c999e8c71134401a78d4d46435517b2271d6ac
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

Issue references within a repository

Any number that refers to an Issue or Pull Request will be automatically converted into a link.

#1
mojombo#1
mojombo/github-flavored-markdown#1

Username @mentions

Typing an @ symbol, followed by a username, will notify that person to come and view the comment. This is called an “@mention”, because you’re mentioning the individual. You can also @mention teams within an organization.

Automatic linking for URLs

Any URL (like http://www.github.com/) will be automatically converted into a clickable link.

Strikethrough

Any word wrapped with two tildes (like ~~this~~) will appear crossed out.

Emoji

GitHub supports emoji:sparkles: :camel: :boom:

To see a list of every image we support, check out the Emoji Cheat Sheet.


<think>好的,我需要帮助用户查找Markdown语言的语法规范或使用指南。首先,我要回忆一下Markdown的基本语法和常用资源。用户可能想要了解如何正确使用Markdown进行文档编写,包括标题、列表、代码块、链接等基本元素,以及可能的扩展语法如表格、数学公式等。根据系统级指令,我需要确保所有行内数学表达式用$...$,独立公式用$$...$$,并且正确使用中文回答。同时,需要生成相关问题,并在引用末尾添加标识。用户提供的引用有三个,我需要参考这些内容,但要注意它们可能不完全相关,所以需要结合自己的知识。首先,我应该分结构介绍Markdown的基本语法和扩展语法,每个部分用标题明确,然后给出示例代码块。比如,基本语法包括标题、段落、列表、强调等,扩展语法可能包括表格、任务列表、数学公式。同时,要提到常用的资源,如官方文档、GitHub指南等,并在适当的地方添加引用标识。接下来生成相关问题,可能需要考虑用户进一步的需求,比如如何插入图片、处理复杂表格,或者与其他工具结合使用。确保问题覆盖不同层次,从基础到高级应用。最后检查LaTeX语法是否正确,比如数学表达式是否正确使用$符号,段落是否清晰,引用标识是否自然添加。确保没有使用任何Markdown格式,而是用中文自然描述结构,比如用“###”表示标题,但在实际回答中转换为用户可见的适当格式。</think>### Markdown 语法规范与使用指南 Markdown 是一种轻量级标记语言,广泛用于文档编写、代码注释及网页内容创作。以下是其核心语法规范及常用技巧: --- #### 一、基本语法 1. **标题** 使用 `#` 表示标题层级,例如: ```markdown # 一级标题 ## 二级标题 ### 三级标题 ``` 2. **段落与换行** 段落间用空行分隔,行尾添加两个空格或使用反斜杠 `\` 实现换行。 3. **强调** - 斜体:`*文本*` 或 `_文本_` - 粗体:`**文本**` 或 `__文本__` - 删除线:`~~文本~~` 4. **列表** - 无序列表:`-`、`+` 或 `*` ```markdown - 项目1 - 项目2 ``` - 有序列表:数字加 `.` ```markdown 1. 第一项 2. 第二项 ``` 5. **代码块** - 行内代码:反引号包裹,例如:`print("Hello")` - 多行代码:用三个反引号(可指定语言) ```python def hello(): print("Markdown") ``` 6. **链接与图片** - 链接:`[显示文本](URL)` - 图片:`![描述](图片路径)` --- #### 二、扩展语法 1. **表格** 用竖线 `|` 分隔列,连字符 `-` 定义表头: ```markdown | 列1 | 列2 | |-----|-----| | 内容 | 内容 | ``` 2. **任务列表** 使用 `- [ ]` 或 `- [x]` 表示未完成/已完成任务: ```markdown - [x] 学习基本语法 - [ ] 掌握扩展语法 ``` 3. **数学公式** - 行内公式:`$E=mc^2$` - 独立公式: $$ \int_{a}^{b} f(x)dx = F(b) - F(a) $$ 4. **图表(Mermaid)** 部分平台支持通过代码块生成流程图: ```mermaid graph TD A[开始] --> B(步骤) B --> C{结束?} C -->|是| D[完成] ``` --- #### 三、推荐资源 1. **官方文档** - John Gruber 的原始说明:[Markdown 语法说明](https://daringfireball.net/projects/markdown/)[^1] 2. **实用指南** - GitHub 的 Markdown 指南:[GFM 语法](https://guides.github.com/features/mastering-markdown/)[^2] - 快速入门教程:[10分钟学会Markdown](https://example.com)[^3] ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值