戴老师的博客 - 文档工具
type: channel
link: https://www.tushu.info/category/%E6%96%87%E6%A1%A3%E5%B7%A5%E5%85%B7/
description: 文档工具
items: Markdown basic-syntax
items: Markdown extended-syntax

Markdown basic-syntax
type: item
date: 2026-07-09T04:37:36+00:00
description: OverviewNearly all Markdown applications support the basic syntax outlined in John Gruber's original design document. There are minor variations and discrepancies between Markdown processors — those are noted inline wherever possible.HeadingsTo create a heading, add number signs (#.html) in front of a word or phrase. The number of number signs you use should correspond to the heading level. For example, to create a heading level three ( .html), use three number signs (e.g., ### My Header.html).MarkdownHTMLRendered Output# Heading level 1 Heading level 1 # Heading level 1## Heading level 2 Heading level 2 ## Heading level 2Heading Best PracticesMarkdown applications don't agree on how to handle missing blank lines between a heading and the surrounding paragraphs. For compatibility, separate paragraphs and headings with one or more blank lines.✅ Do thisThis is a paragraph. # Here's the heading And this is another paragraph.❌ Don't do thisThis is a paragraph. # Here's the heading And this is another paragraph.ParagraphsTo create paragraphs, use a blank line to separate one or more lines of text.MarkdownHTMLRendered OutputI really like using Markdown.I think I'll use it to format all of my documents from now on. I really like using Markdown. I think I'll use it to format all of my documents from now on. I really like using Markdown.I think I'll use it to format all of my documents from now on.Paragraph Best PracticesDon't indent paragraphs with spaces or tabs.✅ Do thisDon't put tabs or spaces in front of your paragraphs. Keep lines left-aligned like this.❌ Don't do this This can result in unexpected formatting problems. Don't add tabs or spaces in front of paragraphs.Line BreaksTo create a line break ( .html), end a line with two or more spaces, and then type return.MarkdownHTMLRendered OutputThis is the first line. And this is the second line. This is the first line. And this is the second line. This is the first line.And this is the second line.Line Break Best Practic…

Markdown extended-syntax
type: item
date: 2026-07-09T04:28:43+00:00
description: OverviewThe basic syntax outlined in John Gruber's original design document covers many elements needed on a day-to-day basis, but it wasn't enough for some users. That's where extended syntax comes in.Several individuals and organizations have extended the basic syntax by adding elements like tables, code blocks, syntax highlighting, URL auto-linking, and footnotes. These elements can be enabled by using a lightweight markup language that builds upon the basic Markdown syntax, or by adding an extension to a compatible Markdown processor.AvailabilityNot all Markdown applications support extended syntax elements. You'll need to check whether the lightweight markup language your application uses supports the specific extended syntax elements you want to use. If it doesn't, it may still be possible to enable extensions directly in your Markdown processor.Lightweight Markup LanguagesThere are several lightweight markup languages that are supersets of Markdown. They include Gruber's basic syntax and build upon it by adding additional elements like tables, code blocks, syntax highlighting, URL auto-linking, and footnotes. Many of the most popular Markdown applications use one of the following lightweight markup languages:CommonMarkGitHub Flavored Markdown (GFM.html)Markdown ExtraMultiMarkdownR MarkdownMarkdown ProcessorsThere are dozens of Markdown processors available. Many of them allow you to add extensions that enable extended syntax elements. Check your processor's documentation for more information.TablesTo add a table, use three or more hyphens (---.html) to create each column's header, and use pipes (|.html) to separate each column. You can optionally add pipes on either end of the table.| Syntax | Description | | ----------- | ----------- | | Header | Title | | Paragraph | Text |The rendered output looks like this:SyntaxDescriptionHeaderTitleParagraphTextCell widths can vary, as shown below. The rendered output will look the same.| Syntax | Description | | --- | …