Markdown

Markdown is a plain-text formatting syntax created by John Gruber in 2004. Symbols such as # for headings, * for emphasis and - for list items mark up the text, and a converter turns it into HTML or other formats.

Why it matters

Markdown files are readable even without rendering, work well with version control and are easy to write in any text editor. It is the standard for README files, documentation, notes and many chat and forum tools. Several flavours exist, such as CommonMark and GitHub Flavored Markdown, which add or standardise features like tables.

Example

# Project title

Some **bold** and *italic* text.

- First item
- Second item

[Documentation](https://example.com)

This renders as a heading, a paragraph with emphasis, a bullet list and a link. Saved as README.md, it displays formatted on code hosting sites.

Common mistakes

• Assuming every renderer supports the same extras. Tables, task lists and footnotes vary by flavour.
• Forgetting a blank line before a list or code block, which can stop it rendering.
• Pasting raw HTML from untrusted users without sanitising, which can allow script injection.

Related

• HTML
• Text editor
• Version control
• Open vs proprietary format

यह पेज सामान्य जानकारी है, जिसे हमारी संपादकीय टीम ने लिखा है और दस्तावेज़ीकरण बदलने पर अपडेट किया जाता है। सर्वर और प्रदाता अलग-अलग होते हैं, इसलिए बदलाव पहले सुरक्षित तरीके से जाँचें। देखें: संपादकीय नीति और अस्वीकरण.