README.md

In atusy/minidown: Create Simple Yet Powerful HTML Documents with Light Weight CSS Frameworks

minidown

Create simple yet powerful html documents with lightweight CSS frameworks.

Installation

CRAN version

install.packages("minidown")

Development version

remotes::install_github("atusy/minidown")

Features

• Light weight CSS frameworks
  • sakura (default)
  • spcss
  • water
  • mini (archived)
  • and more in the future based on the list in Awesome CSS Frameworks
• Code folding
• for source, output, message, warning, and error
• Tooltip
• Floating TOC
• Math with KaTeX
• HTML5
• The Pandoc's HTML5 template is minimally modified by
  • removing math section to support KaTeX CDN even if self contained
  • wrapping body paragraphs by the <article> tag.
• Output format is HTML4 as an exception if framework = "bootstrap".

Live Examples

• Official demo
  • https://minidown.atusy.net/
• Package vignettes
  • digest, littler, spdlog, and tidyCpp by \@eddelbuettel

Philosophy

In the order of priority.

1. Simple and extensible developments
   • Use less external dependencies such as JavaScript.
   • Let Pandoc do things as much as possible
     • Not to reinvent the wheel
2. Light weight output results

atusy/minidown documentation built on Feb. 19, 2022, 10:34 a.m.