1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Mention commonmark in Markup reference contributing article (#25017)

This commit is contained in:
Lucas Costi
2022-02-10 13:19:51 +10:00
committed by GitHub
parent 089177c998
commit 65a567d3a9
2 changed files with 30 additions and 6 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB

View File

@@ -2,24 +2,48 @@
## Table of contents <!-- omit in toc -->
- [Writing in Markdown](#writing-in-markdown)
- [Callout tags](#callout-tags)
- [Lists](#lists)
- [Usage](#usage)
- [Code sample syntax highlighting](#code-sample-syntax-highlighting)
- [Callout tags](#callout-tags)
- [Usage](#usage-1)
- [Octicons](#octicons)
- [Code sample syntax highlighting](#code-sample-syntax-highlighting)
- [Usage](#usage-2)
- [Operating system tags](#operating-system-tags)
- [Octicons](#octicons)
- [Usage](#usage-3)
- [Tool tags](#tool-tags)
- [Operating system tags](#operating-system-tags)
- [Usage](#usage-4)
- [Tool tags](#tool-tags)
- [Usage](#usage-5)
- [Reusable and variable strings of text](#reusable-and-variable-strings-of-text)
## Writing in Markdown
[Markdown](http://daringfireball.net/projects/markdown/) is a human-friendly syntax for formatting plain text. Our documentation is written with [GitHub Flavored Markdown](https://docs.github.com/en/github/writing-on-github/about-writing-and-formatting-on-github), a custom version of Markdown used across GitHub.
[Markdown](http://daringfireball.net/projects/markdown/) is a human-friendly syntax for formatting plain text. Our documentation is written with [GitHub Flavored Markdown](https://docs.github.com/en/github/writing-on-github/about-writing-and-formatting-on-github), a custom version of Markdown based on the [CommonMark specification](https://github.github.com/gfm/), and it is used across GitHub.
This site's Markdown rendering is powered by [`/lib/render-content`](/lib/render-content), which is in turn built on the [`remark`](https://remark.js.org/) Markdown processor.
## Lists
In a list item, the general rules for additional content after the first paragraph are:
* Images and subsequent paragraphs should each **be on their own line and separated by a blank line**.
* All subsequent lines in a list item **must match up with the first text after the list marker**.
### Usage
For example, this is the correct way to write list items with multiple paragraphs or objects:
```markdown
1. Under your repository name, click **Actions**.
![Actions tab in the main repository navigation](/assets/images/help/repository/actions-tab.png)
This is another paragraph in the list.
1. This is the next item.
```
![Image demonstrating how to write CommnMark-compliant Markdown lists](/assets/images/commonmark-lists.png)
## Callout tags
Callouts highlight important information that customers need to know. We use standard formatting and colors for different types of callouts: notes, warnings, and danger notices. Use tags before and after the text youd like included in the callout box.