Items to check in preview
- Heading levels and automatic table of contents
- Bullet points, numbered lists, quotations, tables
- Inline code and code blocks
- Links, images, line breaks, highlighting
Steps to check Markdown
- Paste the Markdown or load the file.
- Refresh the preview and check the headings and table of contents.
- Check tables, code, links, and images in sequence.
- Use search and copy to reflect corrections in the original text.
Why display differences occur
The supported notation and line break rules differ depending on the display destination, such as GitHub Flavored Markdown. Please also check the preview of the final destination.
Embedded HTML and scripts are restricted for security. Use the preview to review document structure, not execution results.
Example: Check README headings and tables before publishing
READMEs can be difficult to read if the heading hierarchy is skipped or the table separators are missing.
Use the preview to move from the table of contents to each section and check the start and end of code blocks and link destinations.
- Load README.md.
- Check the order of headings and table of contents.
- Check the display of tables and code blocks.
- Review the link string and URL and correct the original text.
There is a difference between the preview display and the Markdown engine of the publishing destination, so please make a final check at the publishing destination as well.
Frequently asked questions
- Are Markdown files sent to the server?
- Files are loaded and previewed in your browser and are not sent to Develop Tools servers.
- Is it displayed exactly the same as GitHub?
- Although it supports major notations, there may be differences due to extended notation, CSS, line break rules, etc.
Try It in Your Browser
Your input is processed entirely in your browser. Keep the original data, review the output, and only then save or share it.
Open Markdown preview/viewing tool