askonomm/clarktown

A zero-dependency Markdown parser.

clarktown's Issues

Links break textual checkboxes

Text like: [x] [something](http://google.com), which is valid Markdown, is broken and ends up being ] something.

Add full test coverage

Support dash unordered lists

Add `id` attributes to headings based on value to enable linking to a heading

At least one space is required after a `#` character for an ATX heading block

Link detection fails when there's a apostrophe `'` in the label

Code blocks break newlines

Support setext headings

Spec: https://spec.commonmark.org/0.30/#setext-headings

Implement list block newline correctors

Code blocks are rendered incorrectly if they come after text without a new line

    Example:
    ```clojure 
    (def spouse 
      {:name "Alice"
       :profile-pic-href "alice.png"})
    ```

gets rendered like:

HTML:

<p>Example:
<code></code>`clojure 
(def spouse 
  {:name "Alice"
   :profile-pic-href "alice.png"})</p>

ATX headings without following empty line get rendered wrong

Following Markdown:

### Composition
You may have noticed the line with the note: _Where to begin the query?_
In our application, we have _one_ normalized-state. So we want _one_ query to get _one_ tree to pass to our render function. 

Coming back to our complete code from before, we can replace the `person` function with our component:

gets rendered like:

(Note: the ticks around person are part of my stylesheet, it is not a bug.)

Make text emphasis better

This means that:

1. Bold text can be created by surrounding a word with both ** and __ characters, whereas currently only ** is supported.
2. Italic text can be created by surrounding a word with both * and _ characters, whereas currently only _ is supported.
3. Bold and italic text can be created by surrounding a word with both *** and ___ characters.

Do not detect an ATX heading block when there's more than 6 `#` characters

Overwrite parsers and correctors via a config map instead

Allow an ATX heading block to precede with up to 3 spaces

Bold text rendered in a ordered list if a block starts with bold text

Links where the label has dashes (`-`) do not get parsed

Improve architecture

Currently the naming of things is a bit of a mess. There's no real distinction between a matcher, parser, renderer, and they are hard to explain as a result of it. On top of it with the addition of a correction mechanism (added in #15) it creates a need to introduce a easy way to also add additional correctors, making the re-design of the architecture even more important.

I believe I can do it without changing the underlying API, so those who use Clarktown for rendering Markdown with the default parsers and things can continue to do so without needing to change anything, and perhaps even those who built custom parsers can get away fairly easily.

Support triple-dash horizontal lines

ATX heading block corrector should check for code block presence

Currently the ATX heading block corrector runs even when it's inside a code block. It shouldn't.

Underscores in links get rendered into `<em>`'s

We shouldn't parse link URL's.

Support indented code blocks