1.0.0 • Published 3 years ago

showdown-tufte v1.0.0

Weekly downloads
15
License
ISC
Repository
github
Last release
3 years ago

showdown-tufte

A Showdown Extension to output HTML for use with Tufte-CSS

Introduction

Tufte-CSS is a stylesheet to make it easy to typeset HTML content using Tufte's iconic two-column handout style. But it makes some strong assumptions about the markup that it will be used with, and no markdown compiler is going to meet those assumptions by default. But this extension enables showdown to generate HTML to be styled by Tufte-CSS.

Usage

Get it

  • Node: It's on NPM as showdown-tufte.
  • Browser: Use unpkg as CDN. https://unpkg.com/showdown-tufte@1.0.0/index.js

From the browser

let md = "<your markdown here>";
let converter = new showdown.Converter({ 'extensions': ['tufte'] });
let html = converter.makeHtml(text);

In action

This extension was originally developed for use in uncompiled.