Draft a Compact Runbook with the Live Markdown Preview

Build a short fictional runbook in Split view, use the toolbar for common syntax, and verify the rendered preview before exporting.

By DevSphere Editorial · · 5 min read

Open Markdown Editor

Start with a small, structured document

A short runbook needs a clear title, a sequence of actions, and a place to record a verification result. Markdown Editor provides a Markdown textarea and a Preview pane, with Split view showing both together. Open the tool and replace or adapt its example content with a fictional procedure. The editor works in the current page; it does not fetch files, synchronize a remote document, or save your work to a team repository.

Use the toolbar's H1 and H2 buttons for headings, the ordered-list button for steps, and the task-list button for items that a reviewer can check. The buttons insert Markdown around the selected text or insert a placeholder if no selection exists. Start with a brief sample so you can see exactly where the text goes. The textarea has no spellcheck, and the shown Ctrl+B and Ctrl+I title text should not be assumed to provide working keyboard shortcuts.

# Preview service check\n\n## Before starting\n- [ ] Use the fictional test workspace\n- [ ] Confirm the sample page is available\n\n## Steps\n1. Open the sample page.\n2. Record the displayed status.\n\n> Stop if the sample is unavailable.

Read Split, Edit, and Preview modes

Split is the most useful mode while drafting because changes in Markdown appear beside their rendered form. Edit shows only the Markdown input, while Preview shows only the rendered HTML. Choose the mode that matches the current task: edit a long passage without a narrow preview, inspect the final appearance without distraction, or keep both visible while iterating. The Wrap checkbox changes how long lines display in the textarea; it does not insert line breaks into the Markdown source.

The statistics above the editor show character, word, and line counts for the Markdown source, not for the rendered page. A fenced code sample and Markdown punctuation are included in those counts. The preview is generated by a lightweight set of regular-expression transformations rather than a complete CommonMark parser. Simple headings, emphasis, links, lists, task boxes, code, tables, and blockquotes are useful, but more complex nesting should be verified in the final publishing system.

Use the toolbar and verify its insertion

Select words before pressing Bold, Italic, or Strikethrough to wrap the selection. If no text is selected, the toolbar inserts a placeholder phrase inside the delimiters. Heading buttons add a prefix, while link and image buttons insert Markdown syntax with a placeholder URL. Code Block inserts a fenced block; Quote, Unordered List, Ordered List, Task List, Table, and Horizontal Rule provide common starters. Always inspect the caret location and new Markdown after an insertion.

The toolbar edits the current Markdown string and then restores focus to the textarea after the state update. If an insertion lands in a surprising place, undo through your normal editing workflow or inspect the raw source before continuing. This editor has no dedicated undo history or autosave control in its interface. Copy the Markdown or export a `.md` file at a deliberate checkpoint if the draft matters.

Toolbar sequence\n1. Type: Verify the sample page.\n2. Select the sentence and click Bold.\n3. Preview should show bold text.\n\nExpected Markdown\n**Verify the sample page.**

Check common preview details

The parser handles one-to-six hash headings at the beginning of a line, simple emphasis delimiters, strikethrough, inline code, fenced code blocks, links, images, blockquotes, horizontal rules, lists, and basic tables. A table needs pipe-delimited rows and a separator row made of hyphens and optional colons. The parser is pattern-based, so unusual pipes inside cells, nested lists, complex inline syntax, and multiline constructs may not render the way a full Markdown engine would.

The preview passes generated HTML through a sanitizer. The sanitizer permits a limited set of tags and attributes, strips disallowed markup, and restricts link and image URL protocols. This helps protect the live preview, but it does not mean every external resource is trustworthy or that the preview reproduces a production renderer. Images can depend on remote content and network availability, while sanitized or unsupported markup may be removed or displayed differently.

Troubleshoot a flat or unexpected preview

If a heading appears as plain text, verify the number sign is at the beginning of its line and followed by a space. If a code block absorbs later text, check for matching triple-backtick fences on their own lines. If a table stays as separate rows, inspect the pipe delimiters and the separator row. For emphasis, check paired marker characters and avoid assuming every nested combination is supported. Use the Markdown source as the exact reference when the rendered result is ambiguous.

If a toolbar action appears to do nothing, click in the Markdown textarea, select the intended text, and confirm the current mode includes the edit pane. In Preview-only mode the editor textarea is not shown. Switch to Edit or Split before continuing. The Clear button asks for confirmation, but clearing removes the current in-memory document. Copy or export a needed draft first, then verify the resulting file rather than relying on the browser tab to preserve state.

Export a verified draft

Copy places raw Markdown on the clipboard, `.md` downloads a file named `document.md`, and `.html` downloads a simple standalone HTML document with minimal CSS. The HTML export is not a full publication theme and will not include the surrounding app's styling. It is built from the parser output, so compare it with the Preview pane and open the file in a safe local viewer before sharing. Confirm that links and image references point to intended destinations.

The live preview uses sanitizeHtml, while the HTML export constructs its body from the parser without applying that preview sanitization step. Do not treat preview safety as proof that an exported file is safe to distribute, especially when Markdown includes links or externally sourced images. Export only trusted, reviewed content and inspect the resulting file. For organizational publication, use the approved renderer, security review, and content approval workflow rather than using this utility as the final publishing system.

Export checklist\n- Review Markdown in Edit mode.\n- Check the rendered Preview.\n- Copy or download the source.\n- Inspect exported HTML separately before sharing.

Browse all tutorials