remarkify 0.0.1

Combines Markdown files for RemarkJS


To use this package, run the following command in your project's root directory:

Manual usage
Put the following dependency into your project's dependences section:

InfoReference

Remarkify

This tool will combine Markdown files to be used together with remark. The tool takes a list of Markdown files, combines the content of those and outputs the result to an HTML file.

An HTML template file is used to generate the final result. This can be any file containing: {{ slides }}. {{ slides }} acts as a placeholder and will be replaced with the combined Markdown files. The template is expected to contain the HTML boilerplate necessary for remark.

A plain text file containing the ordering of the slides is necessary. The file should contain the basename (without the directory path) of the Markdown files, one file per line.

Usage

Specify the Markdown files to combine as arguments, the HTML template to use with the -t flag, the slides ordering file using -s and where to place the output using the -o flag. Example: 

$ cat template.html
<html>
  <body>
    {{ slides }}
  </body>
</html>

$ cat slides_ordering.txt
foo.md
bar.md

$ ls slides
bar.md foo.md

$ remarkify -t template.html -o index.html -s slides_ordering.txt slides/*.md

Building

Build with Dub, just by invoking it: dub. Building on Linux using LDC will result in a completely statically linked binary that should work on all distributions and versions.

Running the Tests

Run the tests by invoking dub test.

Authors:
  • Jacob Carlborg
Dependencies:
none
Versions:
0.0.1 2017-Jun-09
~master 2017-Jun-09
Show all 2 versions
Download Stats:

  • 0 downloads today

  • 0 downloads this week

  • 0 downloads this month

  • 10 downloads total

Score:
0.8
Short URL:
remarkify.dub.pm