How to Use the Markdown Test Document
How to Use the Markdown Test Document
This guide explains how to use the test-formatting.md
file to test all the enhanced Markdown features in our editor.
Testing Process
- Create a New Document in the editor
- Copy the Content from
test-formatting.md
into your new document - Save the Document to ensure all formatting is preserved
- Toggle between Edit and Preview mode to see how the formatting renders
Features to Verify
Basic Text Formatting
- Bold: Text should appear in bold (like this)
- Italic: Text should appear in italics (like this)
- Strikethrough: Text should have a line through it (
like this) - Highlighting: Text should have a yellow background (like this)
- Inline Code: Text should appear in a monospace font with a gray background (
like this
) - Superscript: Text should appear slightly above the line (^like this^)
- Subscript: Text should appear slightly below the line (~like this~)
- Colors: Text should appear in the specified color (like this)
Headings
- Six levels of headings should display with decreasing sizes and proper font weights
Lists
- Bullet Lists: Should display properly indented with bullets
- Numbered Lists: Should display with sequential numbers
- Task Lists: Should display with checkboxes (empty or filled)
- Nested Lists: Should maintain proper indentation for sublists
Code Blocks
- Code should display in a monospace font with a gray background
- Syntax highlighting should work for different languages (JavaScript, Python, HTML)
- The language name should appear in the top-right corner
Blockquotes
- Text should appear indented with a left border
- Nested blockquotes should have additional indentation
Links
- Links should be clickable and styled in blue
- Links with formatted text should maintain the formatting
Tables
- Tables should display with proper borders, alignment, and styling
- Header row should be visually distinct
Custom Formatting
- Text Colors: Text should display in the specified colors using the syntax:
text
- Combined Formatting: Multiple formatting options should work together
Testing Tools
- Use the built-in formatting buttons to add/modify formats
- Verify that each button adds the correct markdown syntax
- Check that the preview correctly renders all formatting elements
- Test copying formatted content and pasting it elsewhere
- Test downloading the document as Markdown
Common Issues to Check
- Ensure nested formatting works (bold inside a list, colored text in a blockquote)
- Verify that tables render properly with various content types
- Check that code blocks preserve indentation and line breaks
- Confirm that task list checkboxes work correctly
If you encounter any issues with formatting, please note them down with:
- The specific formatting that failed
- The expected behavior
- The actual behavior observed
This document will help ensure all formatting features work as expected.