What is Markdown?
Markdown is a lightweight writing language created by renowned independent blogger John Gruber. With a few simple symbol-based syntax rules, you can format your content while you write. This lets you focus on the text itself, write more smoothly, stay immersed in your output, and boost your writing efficiency.Why use Markdown?
When writing in Markdown, you simply type a few syntax symbols and the editor formats your content automatically. The benefit: by the time you finish your article, the formatting is done as well. You no longer need to use the menu bar to change character styles, bold text, and so on. This boosts your writing efficiency.- Simple syntax: Markdown syntax uses simple, common marker symbols. Even non-programmers can learn it in just a few minutes.
- Strong compatibility: Open the file in any editor and the formatting stays intact.
- Focus on content: With Markdown, you never need to worry about formatting. Its clean, elegant format lets your hands stay on the keyboard and helps you immerse yourself in the joy of writing.
Highlights of the DingTalk Docs Markdown upgrade
Scope of support
- Full support for multiple text styles, including bold, italic, strikethrough, underline, superscript and subscript, and highlighted text.
- New support for Katex formulas, including inline style and block style .
- New support for callout block syntax.
- New support for image and link syntax.
- New support for emoji syntax.
- New support for inserting text diagrams via ```mermaid + Enter.
- New support for table syntax.
-
Paste-to-Rich Text supports Markdown with embedded HTML.
Detail improvements
-
Built-in callout block colors that can be quickly specified via
::: + <type>. - New input assist hints, so you no longer need to memorize the many code block syntaxes, callout block types, or emoji codes.
-
User-friendly Markdown input for links:
- Use []() to insert a link placeholder, with auto-focus on the link title input box.
- Use [title]() to insert a link, with auto-focus on the link URL input box to complete the input.
- Typing | | | + Enter inserts a two-row, two-column table with focus on the first cell of the first row. Typing |x| | + Enter sets focus on the first cell of the second row.
- When pasting, a “Convert to Rich Text” option appears whenever appropriate, letting you convert Markdown text into a format supported by DingTalk Docs.
Markdown user guide
DingTalk Docs supports most Markdown syntax. You can use Markdown when you Import, Export, Paste, or Edit.| Common Markdown syntax | Advanced Markdown syntax |
|---|---|
| * Heading 1-6 * Quote * Lists: Numbered List, Bulleted List, task list, and more * Code block * Inline code * Divider * Text formatting: Bold, Italic, Underline, Strikethrough, background color, superscript and subscript, and more | * Link * Image * Formula * Callout block * Table * Emoji * Text diagram |
Import
When creating a document, select “Import as Online document” - “Local document”, then choose a local .md file to import it as a DingTalk Docs document.Export
After editing, you can download the document as a .md file to export it. For the currently supported Markdown formats on export, see ”⏬ Export as Markdown”.Paste
Copy a piece of Markdown text from a plain text editor or a Markdown editor, then paste it into DingTalk Docs. In the paste options that appear, click “Convert to Rich Text” to convert it into the Rich Text format supported by DingTalk Docs. For the Markdown formats supported when pasting, see “🖨️ Paste Markdown text”.Edit
Type specific Markdown-formatted text and press the corresponding trigger key (Space or Enter) to convert the text into the matching format. For the Markdown formats supported during editing, see “⌨️ Edit Markdown”. Go to DingTalk Docs to view the attachment “edit markdown.mp4”.Common Markdown editing syntax
| Feature | Markdown input | Result | |
|---|---|---|---|
| Formatting | Bold | **text** + Space __text__ + Space | Bold |
| Italic | *text* + Space _text_ + Space | Italic | |
| Strikethrough | |||
| Underline | text + Space | Underline | |
| Superscript | ^text^ + Space | ^Superscript^ | |
| Subscript | |||
| Text highlight | ==text== + Space | ==Text highlight== | |
| Inline code | `text` + Space | Inline code | |
| Heading | Heading 1 | # + Space | # Heading 1 |
| Heading 2 | ## + Space | ## Heading 2 | |
| Heading 3 | ### + Space | ### Heading 3 | |
| Heading 4 | #### + Space | #### Heading 4 | |
| Heading 5 | ##### + Space | ##### Heading 5 | |
| Heading 6 | ###### + Space | ###### Heading 6 | |
| Code block | ``` + Enter ```js + Enter | text/x-sh<br />var a = 1;<br /> | |
| Formula | Inline formula | + Space | abc |
| Block formula | + Space | abc | |
| List | Numbered List | 1. + Space a. + Space | 1. List 1. List |
| Bulleted List | * + Space - + Space | * List * List | |
| Task list | [] + Space [x] + Space | * [ ] Task list * [x] Task list | |
| Quote | > + Space | > Quote | |
| Link | []() + Space [abc]() + Space [abc](http://foo) + Space | Add a web link abc abc | |
| Image | ![]() + Space  + Space | Go to DingTalk Docs to upload the “Image”. | |
| Callout block | Default callout | ::: + Enter | ::: Default style ::: |
| Danger callout | :::danger + Enter | ||
| Warning callout | :::warning + Enter | ||
| Info callout | :::info + Enter | ||
| Success callout | :::success + Enter | ||
| Tip callout | :::tips + Enter | ||
| Emoji | :smile: + Space | 😄 | |
| Table | |a|b| + Enter | ||
| Divider | *** + Enter --- + Enter | --- | |
| Text diagram | ```mermaid + Enter | mermaid<br />graph TD<br /> A[Christmas] -->|Get money| B(Go shopping)<br /> B --> C\{Let me think\}<br /> C -->|One| D[Laptop]<br /> C -->|Two| E[iPhone]<br /> C -->|Three| F[fa:fa-car Car]<br /> |
Recommended DingTalk Docs Markdown techniques
Quickly insert a callout block
Type three colons (both English and Chinese colons are supported) + Enter to insert a callout block. Add a type after the colons to quickly set the color.Input assist for emoji, callout blocks, and code blocks
Smart input assist lets you enter the following without memorizing complex codes or types:- Supported emoji codes
- Callout block types
- Code block syntax
Alternative input for links
Common[title](url) syntax is now supported.
Go to DingTalk Docs to view the attachment “Screen Recording 2022-09-06 5.45.34 PM.mov”.