Quarkup

A simple markdown extension that compiles markdown into tailwind styled html.

Disclaimer

This package and documentation is still work in progress.

Contents

• Quarkup
  • Disclaimer
  • Contents
  • Usage
    • Examples
  • Features
  • Custom Syntax
    • Table of Contents

Usage

npx quarkup s|m [options] [command]

Examples

• Compile single project
• Compile multiple projects

Features

• [x] Paragraphs
• [x] Headings with slugs
• [x] Links
• [x] Code blocks
• [x] GitHub Flavored Markdown
• [x] Table of Contents
• [ ] References and Sources
• [ ] Local images

Custom Syntax

Quarkup uses keywords with options:

$keyword:optionA{value}:optionB{value}&

the keyword ($) and option (:) marks can be configured.

Table of Contents

Example: $tableofcontents:maxDepth{1-6 [default: 6]}$

Keyword: tableofcontents

Options:

• maxDepth - 1 up to 6 (default is 6) # Highest acceptable heading