Markdown Dingus
The Markdown Dingus is a specialized testing tool that helps you understand how different Markdown processors handle your content. It provides a three-pane interface where you can edit Markdown, view the generated HTML source, and see the rendered preview simultaneously.
The Dingus uses the same special handling that Marked’s preview does, which includes things like normalizing some syntax and special handling of fenced code blocks. It uses most default settings, ignoring settings like “GitHub newlines” and “GitHub checkboxes,” so the result may differ from what you actually see in the Marked preview based on your configuration.
Contents
What is a “Dingus”?
A “dingus” is a term borrowed from web development that refers to a simple testing tool or sandbox environment. The Markdown Dingus lets you experiment with Markdown syntax and immediately see how different processors interpret it.
Accessing the Dingus
The Markdown Dingus can be accessed from . It’s particularly useful when you’re:
- Learning new Markdown syntax
- Troubleshooting rendering issues
- Choosing between different processors
- Writing documentation that needs to work across multiple systems
Three-Pane Layout
The Dingus window is divided into three synchronized panes:
1. Markdown Input (Left Pane)
- Syntax Highlighting: Your Markdown is highlighted with colors to make structure clear
- Live Editing: Type and see changes reflected instantly in the other panes
- Large Font: 21pt Menlo font for comfortable editing
2. HTML Source (Middle Pane)
- Generated HTML: See exactly what HTML the selected processor creates
- Syntax Highlighted: HTML is color-coded for easy reading
3. Rendered Preview (Right Pane)
- Live Preview: See how your Markdown will look when rendered
- Emoji Support: GitHub-style emojis like
:zzz:are converted to images - Auto-scrolling: Automatically scrolls to show your current edit position
Processor Selection
Use the dropdown at the top to switch between different Markdown processors:
- MultiMarkdown: Full-featured processor with tables, footnotes, and math support
- CommonMark: Standard, fast processor following the CommonMark specification
- Discount (GFM): GitHub Flavored Markdown with task lists and tables
- Kramdown: Advanced processor with additional features like IALs and typography
Why Use the Dingus?
Understanding Processor Differences
Different Markdown processors handle syntax differently. The Dingus helps you:
- Compare Output: See exactly how each processor renders the same Markdown
- Debug Issues: Identify why certain syntax isn’t working as expected
- Learn Syntax: Understand the subtle differences between processor implementations
Testing Before Writing
Before committing to a particular Markdown style in your documents:
- Validate Syntax: Ensure your Markdown will render correctly
- Choose Processors: Decide which processor works best for your content
- Experiment Safely: Try new syntax without affecting your actual documents
Common Use Cases
Table Syntax Differences
Some processors handle table syntax differently. The Dingus lets you see which processor best supports your table formatting needs.
Footnote Support
Not all processors support footnotes. Use the Dingus to verify footnote syntax works with your chosen processor.
Math and Special Characters
Test how different processors handle mathematical expressions and special typography characters.
Tips for Effective Use
- Start Simple: Begin with basic Markdown and gradually add complexity
- Test Edge Cases: Try unusual syntax combinations to understand processor limits
- Compare Side-by-Side: Switch between processors to see differences clearly
- Use Real Content: Copy actual content from your documents to test real-world scenarios
The Dingus is a powerful tool for anyone who wants to understand the nuances of different Markdown implementations and ensure their content renders correctly across various platforms and processors.
Next up: MultiMarkdown v5 Specification ▶
Search | Support Site | Knowledgebase | Legal | Privacy | Twitter