bence-toth / markdown-to-markup

A modern markdown → HTML conversion library

Markdown to HTML

A modern markdown → HTML conversion library

...in the making.

markdown-to-markup's Issues

Make sure that backslash escaping works

Add support for emphasis

Of course all four ways must work.

Also inthemiddle of the words.

Create renderer for Table of contents

Make it configurable which heading levels should be included

Add All Contributors

Add this: https://github.com/all-contributors/all-contributors

Put anchors and anchor links on headings

Make it configurable which heading levels should have anchors

Set up CI pipeline to run tests

Rename master branch to main

Provide an interface for override renderers

Add support for images

Wrap it nicely in a figure with an optional figcaption, which should be the same as the alt text or the title.

Add copy to clipboard functionality to code blocks

Write documentation

Switch to a more permissive license

LGPL? MIT?

Indent HTML output

Renderer for image is unpredictable

Currently the renderer for images generates output that renders in an unpredictable way.

The reason for this is that there is a <figure> element being inserted withing a <p> element, which is invalid in HTML.

Solution idea:

• If there is a single image (and nothing else) rendered within a paragraph, the paragraph element should be replaced by the <figure> element which encompasses the image.
• If there are other elements (typically text) rendered around (before/after) the image, the image must not be wrapped in a <figure> element, and <figcaption> also must not be attached – it must render the <img /> element only

Make sure that auto links work

Both with ordinary URLs and email addresses.

Greater that sign needs HTML entity encoding in inline code

This should work:

Some `<blockquote>`

But now you have to write:

Some `<blockquote>`

Add support for blockquotes

All kinds of elements can be embedded in a blockquote, including headings, lists, and even other blockquotes.

Add tests

Add support for dividers

Turn static file compiler to library that compiles from a string

Ampersand sign needs HTML entity encoding in inline code

This should work:

`—`

But now you have to write:

`—`

Add support for code blocks

Features:

• Line numbering
• Syntax highlighting
• Copy to clipboard

Add emoji support

Add support for links

• Ordinary links (absolute + relative)
• Link with relative path
• Reference-style link
• Link with embedded content (images etc.)

Implement and document branching strategy

Setup CD pipeline to publish npm package