1.0.0 • Published 2 years ago

tableau-markdown-it v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

Extended Table Syntax for Markdown

Tableau Tables gives you way more control over the tables you create in Markdown documents. tableau-markdown-it is the version of Tableau for the Markdown-It processor.

Headers

  • Headerless tables
  • Multiline headers
  • Multiple separate headers
  • Headers in columns and rows
  • Captions

Layout

  • Layout uses CSS styles and not inline attributes (making it easier to change the style of a whole document)
  • Per cell alignment and CSS classes
  • Default attributes, both down columns and across rows
  • Table-wide classes
  • Row and column span
  • Continuation lines

Here are some samples.

Installation

  1. Install the extension:

    $  yarn add -S tableau-markdown-it       (npm i -S tableau-markdown-it)
  2. Tell Marked to use it:

    const md  = require("markdown-it")
    const tableau = require("tableau-markdown-it") 
    md.use(tableau)
    // ...
    md.render(your_document)

Writing Tables Using Tableau Tables

Pop on over to the documentation site.