Prepare a Small Handbook for Markdown and HTML Export

Compose a fictional handbook, use the editor's export actions, and compare the standalone HTML output with the live sanitized preview.

By DevSphere Editorial · · 5 min read

Open Markdown Editor

Outline a compact handbook

A short handbook might need a title, a few sections, a checklist, and a reference table. Markdown Editor supports those common elements in one page, with Edit, Split, and Preview modes. Start with a fictional topic and avoid including actual company procedures or private contact information unless the environment is approved for that content. Keep a second copy in the intended document system because this component holds the draft in page state rather than a shared drive.

Type headings directly or use H1, H2, and H3 toolbar buttons. Add short paragraphs and simple bullets, then use Insert Table to insert a sample two-column table. The parser recognizes basic table markup only when it finds pipe-delimited rows and an appropriate separator. It does not provide automatic table of contents, navigation anchors, multi-file organization, or a handbook template, so keep the outline deliberately small.

# Sample handbook\n\n## Purpose\nThis fictional guide explains a review exercise.\n\n## Steps\n1. Open the sample.\n2. Check the displayed result.\n\n| Item | Owner |\n|------|------|\n| Draft | Writer |\n| Review | Editor |

Review the rendered page

Use Split mode while writing so the raw Markdown and Preview remain visible together. Switch to Preview when you want to inspect visual hierarchy without source syntax, then return to Edit for precise changes. The statistics count source characters, words, and lines; they do not measure rendered page length or count table rows as a separate unit. Toggle Wrap to change how long source lines display without changing their actual line breaks.

Check the heading levels, list numbering, table headers, and blank lines. The parser is a set of regular-expression substitutions; it supports common constructs but does not implement every Markdown dialect. Complex nesting, escaped delimiters, unusual table content, or platform-specific extensions may render differently. Treat the live Preview as a helpful local approximation and verify final appearance in the handbook's actual publishing renderer.

Choose a source or rendered export

The Copy action copies Markdown source, preserving the syntax that can be edited later. The `.md` download saves a file named `document.md`, while `.html` creates a standalone HTML file with basic CSS. Choose Markdown when the next system expects Markdown and HTML when a simple static page is useful. Neither action uploads content or publishes the handbook; you must place the file in the approved destination and apply its normal review process.

The exported HTML includes a fixed document title and minimal styles for basic elements such as code, tables, blockquotes, and images. It does not include app-specific theme colors, a navigation sidebar, print rules tailored to your organization, or a full design system. Inspect the downloaded file locally and compare it with the destination requirements. If the target platform rewrites HTML or Markdown, validate an imported copy there before announcing completion.

Account for sanitization differences

Preview content passes through the project's sanitizer, which allows a restricted set of HTML elements and attributes, removes certain disallowed elements, and filters link and image protocols. This behavior can remove markup or attributes that a full renderer would retain. Markdown parser input also escapes angle brackets first, so raw HTML is not treated as an unrestricted authoring language in the preview.

HTML export follows a different path: it inserts the parser output into the generated page without invoking the preview sanitizer. Therefore the preview should not be used as evidence that an exported file containing untrusted Markdown or URLs is safe. Export only trusted and reviewed content, inspect destinations for links and images, and use an approved sanitization and publishing pipeline when handling untrusted contributions.

Troubleshoot missing content in the output

If a paragraph or table row is missing, inspect the source in Edit mode and confirm that it was not inside an unclosed code fence or malformed table pattern. If a heading renders as a paragraph, check its line start and required whitespace. If list items do not group, keep them on adjacent lines and use the parser's simple marker forms. These are heuristics rather than diagnostic error messages, so a rendered page can be incomplete without an explicit warning.

If `.html` or `.md` does not download, check the browser's download permissions and verify that the action was triggered in the active page. If the downloaded HTML looks unstyled, confirm that you opened the new exported file rather than the Preview and that its minimal inline CSS was retained. The export cannot preserve state from a previous browser session. Keep a copy of the source before clearing or navigating away.

Use toolbar actions without losing source

Toolbar buttons insert formatting around selected text or place placeholders when nothing is selected. Link and Image buttons create syntax with a placeholder URL; replace it with an approved destination before exporting. The bold and italic buttons carry tooltip text that mentions Ctrl+B and Ctrl+I, but the component actions are implemented as buttons and do not register keyboard shortcut handlers. Use the visible controls and verify their effect in the Markdown source.

Clear asks for confirmation before replacing the current content with an empty string, but it does not create a recoverable backup. Copy or download the source first if you need to preserve it. There is no autosave, version timeline, collaboration, or in-page restore feature. Once exported, keep the file in a controlled document system and record its owner and revision through that system.

Finish with a publication check

Before distribution, verify the original Markdown, the live Preview, and the exported file independently. Check every heading, list, table, link, and image; confirm the handbook contains no unintended sample text; and ask an appropriate reviewer to verify facts. The editor does not validate links, check accessibility, enforce editorial policy, or verify the accuracy of content. A visually complete page can still include stale instructions or broken references.

Use the tool for drafting and a quick local rendering, then move the reviewed source through the destination's normal build and approval process. If the receiving platform uses another Markdown engine, compare its result rather than assuming full compatibility. Keep user-supplied or external content out of an untrusted export path. This final verification respects the difference between a convenient editor, a sanitized preview, and a production publishing system.

Publication checklist\n- Confirm source is final.\n- Review Preview and exported file.\n- Verify links, images, and table content.\n- Publish only through the approved destination.

Browse all tutorials