Puzle Shapeshifter
About
With Shapeshifter, merge markdown documents, handlebars templates and static html themes into static html files and / or pdf documents.
The tool is currently usable in state.
We work hard to provide you soon lot of cool features. Do not hesitate to share your remarks or issues in dedicated channel.
License
MIT
Roadmap
Generate HTML files from gulp tasksCLI supportAdd default themeToPdf option- Add options to select export
- To PDF
- To Html
Add custom options with dedicated config file per projectAdd a watch option- Add an auto reload option
- Add a CLI command to init a config file
- Add custom options with dedicated config file per folder
- Fix issues:
- PhantomJS Font Face support: not working yet
- Add themes support
- Add themes :
- Reveal.JS
- HTML5 Wrapper...
- Add plugins support
Prerequisites
- Node > 6.2
- Npm
- Gulp
Install
Using as CLI tool
$npm i -g puzle-shapeshifter
Development
Install vendors
$npm install
Install global tools
$npm run installGlobal
Test
Running tests
$npm test
Usage
Shapeshifter is provided as binary.
The application takes all documents in the source folder and compiles them into a dist folder.
Shapeshifter can be executed like so :
shapeshifter [options]
CLI Options
-h,--helpOutput usage information-V,--versionOutput the version number-s,--src <item>The markdown files location,_toCompileby default-d,--destination <item>The generation destination,_compiledby default-t,--templates <item>The templates location,_templatesby default-w,--watchWatch each change and compile the document
Use a config file
You can use a config file to define the compilation options.
First, create a shapeshifter.config.js file at your root project directory with
this structure :
moduleexports = src: './_toCompile/' dest: './_compiled2' templateLocation: './_templates' watch: false pdfConfig: "format": "A3" "border": "top": "25mm" // default is 0, units: mm, cm, in, px "right": "20mm" "bottom": "15mm" "left": "20mm" ;The config file options:
moduleexports = src: '' // the markdown files location, `_toCompile` by default dest: '' // the generation destination, `_compiled` by default templateLocation: '' // the templates location, `_templates` by default, watch: true // enable the watcher : compile automatically the document when changes occurred pdfConfig: {} // the pdf compilation options, see https://github.com/marcbachmann/node-html-pdf#options;For the pdf options, see the node-html-pdf documentation.
The config file override the default options.
Warning : the options given as command arguments override these defined in the config file.
Create a template
The template are located by default in the _templates folder.
They follow the handlebars format.
- See HandlebarsJS
In your template, you can add variables which be replaced during compilation step.
The frontmatter variables are prefixed
by data.* expression.
{{data.title}} I'm the Header {{data.title}} {{{data.randomvar}}} I'm the article {{{content}}} The content variable define the markdown document body.
The other variables are linked to the markdown frontmatter.
You are free to create variables you need.
Create a compilable document
The compilable documents are located in the _toCompile folders by default.
The frontmatter variable template is required. Define here
the template file used during the compilation step, without the *.hbs
suffix.
Do not forget to add all frontmatter variables used by the template you have defined.
You can inject the data defined in the frontmatter in the content section.
Example:
--- title: I'm the title author: Cédric Charière Fiedler template: page randomvar: random --- ## First title {{{data.title}}} **I'm Bold**