Guides
Turn your Markdown source into the copy you need.
Choose a guide for writing, tables, a README preview or document export. Keep the Markdown source and inspect the chosen output: HTML and Word do not have the same layout or editing behaviour.
Try an exampleWrite and inspect the document structure
Use headings to build an outline, then check lists, emphasis and code in Preview. When a README uses local images, add those images locally; remote images remain placeholders in the editor. A local preview cannot promise identical rendering on every publishing platform.
Check table columns in source and preview
Create the header and separator row, then add the data rows. Check that each value stays in its intended column, especially when a cell contains a pipe character. A Markdown table is a document table; it does not calculate spreadsheet formulas.
Choose HTML or an editable Word copy
Choose HTML for a rendered browser document and Word when the recipient needs to edit a document. Check the export options for images and links. For PDF, use the browser’s print settings and inspect pagination; the editor does not guarantee the same page layout across browsers.
Check the downloaded copy
- Reopen the export and check headings, lists, tables, code blocks and image handling.
- Save the Markdown source before closing the tab; unsaved draft storage is optional.
- Keep the original files until you have checked the downloaded copy.
Practice without personal files
Open the sample Markdown and inspect its heading, checklist, two-row table and code block. Change one table value and confirm the preview updates. Save Markdown and HTML copies, reopen both and check that the source remains editable while the HTML shows the intended structure.
The practice files contain synthetic examples. Their text is in English.
Open the practice guide