Skip to content

schoblaska/writeup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

Generic components from jeromegn/DocumentUp to generate static HTML documentation from Markdown.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published