Source code guides

Turn release notes into an HTML fragment

·

An HTML fragment can go into an existing article template. Check the generated tags before adding your navigation, styles and document wrapper.

Markdown to HTML Converter

Convert a heading and a checklist

Enter # Release notes, add a blank line and enter - [x] Update docs. With GitHub Flavored Markdown enabled the heading becomes an h1 and the list contains a checked checkbox. The local preview shows the check state as text.

Clear the GitHub option and convert again. The list still renders, and the bracketed x appears as ordinary text.

CommonMark specificationGitHub Flavored Markdown specification

Review a linked image before publishing

Try ![Badge](https://example.org/badge.png). The preview shows Image (Badge). The HTML source contains an img element with that destination. A reader opening the exported HTML can request the referenced image.

Review relative links after moving an HTML file

A document can contain a relative link such as ../images/plot.png. Moving the exported HTML from a notes folder to the site root changes which location the browser resolves for that link. Check it in the destination directory.

Inspect image descriptions and heading levels in the rendered document. Successful conversion of the Markdown syntax does not establish that the image exists at the deployment path or that its description explains the chart.

Common questions

Does the download contain the whole preview?

The download contains the complete generated HTML. The rendered preview has limits on text length, node count and nesting.

How do I show literal markup in a note?

Use a fenced code block to preserve a code example. Inline raw HTML is also escaped during conversion.

Sources

Put it into practice.

Related guides