Portfolio (Mobiles FabLab)

Content and (PDF-) generators for our portfolio (digital & print)

Resources:

• Print layout

Dev Setup

npm install

Usage

1. Place content inside content directory (markdown with yaml front matter)
2. Define build targets in targets.js. Keys of the object are valid values for the target argument to the generate command
3. Create templates (in templates directory)
4. Generate html output: npm run generate <target> e.g. npm run generate portfolio
5. Generate html and pdf output: npm run generate <target> pdf e.g. npm run generate portfolio pdf

Troubleshooting

If you should receive this error:

FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory

You have to allocate more memory to node.js. You can do this by typing

export NODE_OPTIONS=--max_old_space_size=4096

Relevant StackOverflow post

Guides

Templating

This project uses handlebars.js for templating. Please refer to the Language Guide on how to write handlebars templates.

Markdown

The markdown parser used in this project is called markdown-it. It implements the CommonMark standard plus some extensions. Please refer to the CommonMark Spec for valid syntax.