MV Tools

A real Markdown publishing check

How to Write, Preview, and Publish Markdown Without Formatting Surprises

A practical workflow for README files, documentation, notes, and web content: write portable Markdown, preview representative content, and verify the actual publishing renderer before relying on the result.

MV Tools Editorial TeamUpdated 8 min read

Open tool

Treat Markdown as a source format, not a guaranteed final appearance

Markdown is intentionally small, but platforms choose their own renderer, extensions, themes, sanitization rules, and handling of links, tables, line breaks, and HTML. A document that looks correct in one preview can still look different in a repository host, CMS, issue tracker, knowledge base, or email client.

Write the source so its meaning remains clear without a particular theme: use a single descriptive top-level title where the destination expects one, keep headings in logical order, use real lists for lists, and put code in fenced blocks. Then preview a representative section in the actual destination before publishing a long document.

Use one representative draft to inspect the syntax your final publisher must support.
Use one representative draft to inspect the syntax your final publisher must support.

Build a reviewable structure before polishing prose

Start with an outline: title, short purpose statement, the main sections a reader needs, and a concise next action. Use heading levels to express hierarchy rather than using bold text or visual spacing as a substitute. Skipping from a level-two heading to a level-four heading makes a document harder to scan and can reduce accessibility for readers using navigation tools.

Use descriptive link text that tells a reader what will open. Put a URL in angle brackets or use a Markdown link when it is a destination; do not rely on a bare, vague “click here.” For tables, first confirm that the target supports Markdown tables and keep cells short. A compact list is often more readable than a wide table on small screens.

Use one representative draft to inspect the syntax your final publisher must support.
Use one representative draft to inspect the syntax your final publisher must support.

Preview the syntax that is easy to misread

Before publishing, include a small test of the features you rely on: nested lists, a link containing query parameters, inline code, a fenced code block with its language label, a quote, a table if needed, and non-ASCII text. Check that code characters were not converted to typographic punctuation and that an intentional paragraph break was not collapsed.

MV Tools renders its preview with markdown-it. In this configuration, raw HTML input is disabled and therefore displayed as escaped text; automatic links and typographic replacements are enabled; ordinary line breaks are not automatically rendered as `<br>`. Those are useful local checks, but they are settings of this preview—not a promise about the renderer used by the platform where you publish.

This tool escapes raw HTML; verify the policy of the platform where you will publish.
This tool escapes raw HTML; verify the policy of the platform where you will publish.

Keep raw HTML and generated HTML in their proper place

A Markdown preview may escape raw HTML while another system may allow, remove, or sanitize it differently. Do not assume a preview makes arbitrary HTML safe to publish. If a destination accepts user-supplied HTML, use its documented sanitization and rendering policy, and never concatenate untrusted strings into HTML or script contexts.

The tool can copy the rendered HTML or download a basic HTML document. That export contains the rendered body and document metadata, but no stylesheet or page-specific assets. It is suitable for inspecting generated markup or creating a simple starting point—not for proving that the result will match a themed website, PDF generator, email client, or CMS template.

This tool escapes raw HTML; verify the policy of the platform where you will publish.
This tool escapes raw HTML; verify the policy of the platform where you will publish.

Publish through a small, repeatable checklist

Keep the original `.md` file as the source of record. Review the preview on a narrow screen, open every important link, and inspect code, tables, headings, and quoted material. Publish a small representative page or draft where the final renderer is available, then compare it with the local preview and correct any dialect-specific differences before updating the complete document.

This Markdown tool runs in the browser: editing, rendering, copying, and data-URL downloads do not upload the document to MV Tools. Local processing reduces one exposure route, but it does not change your obligations for secrets, personal data, internal links, or copyrighted material. Use redacted examples for troubleshooting and follow the rules of the system where the final document will live.

Use one representative draft to inspect the syntax your final publisher must support.
Use one representative draft to inspect the syntax your final publisher must support.

Frequently asked questions

Why does Markdown look different after I publish it?

The destination may use a different renderer, enabled extensions, theme, HTML policy, line-break rule, or CSS. Verify the actual platform with a representative sample.

Does this preview allow raw HTML?

No. Its markdown-it configuration disables raw HTML, so it is escaped and displayed as text. Other publishing systems can behave differently.

Can I use the HTML download as a finished webpage?

It is a basic HTML document without styles or site assets. Use it for inspection or a starting point, then add an appropriate design and test in its final environment.