Skip to content

nedkelly/twing-markdown

Repository files navigation

Twing Markdown

NPM version Build Status Coverage percentage

Implements Marked for Twing using twig {% markdown %} {% endmarkdown %} tags.

NB: Not yet implemented in browser!

Example

Twig:

{# With Filter #}

{{ '# Some markdown here...'|markdown }}

{# With Tag #}

{% markdown %}
  # Some markdown here...
{% endmarkdown %}

HTML:

<h1 id="some-markdown-here-">Some markdown here...</h1>

Usage

import { TwingLoaderFilesystem, TwingEnvironment } from "twing";
import { TwingExtensionMarkdown } from "twing-markdown";

const loader = new TwingLoaderFilesystem('/path/to/templates');
const twing = new TwingEnvironment(loader);

twing.addExtension(new TwingExtensionMarkdown());

Twing

Read the Twing Documentation for more information.

Contributing

  • Fork this repository
  • Code
  • Implement tests using tape
  • Issue a pull request keeping in mind that all pull requests must reference an issue in the issue queue

Thanks To

License

Copyright © 2018 Nathan Kelly. Released under the 2-Clause BSD License.