Project

writeup

0.0
No commit activity in last 3 years
No release in over 3 years
Generic components from jeromegn/DocumentUp for generating static HTML documentation from Markdown.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 0

Runtime

 Project Readme

Writeup

Writeup is an extraction of the components of DocumentUp that handle converting Markdown to HTML files, wrapped in a gem with an executable.

Installation

gem install writeup

Alternatively, you can add Writeup to your gemfile and use the library directly from within your code.

Usage

Writeup generates a single HTML file with styles in-lined.

Command line

writeup path/to/document.md path/to/output.html

Library

Writeup.render(markdown_string, destination_path)

Example

Check out what this README file looks like after being run through Writeup here.