initial commit

Author: Tmw

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+node_modules

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017, CoderDojo Rotterdam (SF)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+# CoderDojo Workshop Core
+
+A basic workshop package that converts Markdown to PDF using CoderDojo Rotterdam (SF) theming.
+
+## Install
+- Create a new folder that'll hold your manual
+- `cd` into your folder and run `npm init -y` to initialize a new node project
+- Pull in this core dependency by running:
+  `npm install coderdojorotterdam-workshop-core --save`
+
+## Config
+In your `package.json` you can override the input and output files by adding this segment to it:
+
+```json
+  "coderdojo_workshop_options": {
+    "file_in": "love2d_lua_installatie.md",
+    "file_out": "love2d_lua_installatie.pdf"
+  }
+```
+
+## Run
+To run the converter, easiest thing is to link to the `.bin/core` in the package.json start script like so:
+
+```json
+  "scripts": {
+    "start": "./node_modules/.bin/core"
+  }
+```
+
+Run `npm start` to start the conversion.
+
+## Examples
+To get a general idea on how to use this, have a look at some examples:
+- Installing Love2D, Lua & Atom [TBA]
+- Building Pong using Love2D and Lua [TBA]
+
+## Components
+All markdown tags are supported as well as custom styling using HTML / CSS. For available CSS classes have a look in our [CSS file](main.css).
+
+## License
+[MIT](LICENSE)

index.js

@@ -0,0 +1,51 @@
+#! /usr/bin/env node
+
+const markdownpdf = require('markdown-pdf');
+const hljs = require('highlight.js');
+const classy = require('remarkable-classy');
+const path = require('path');
+const fs = require('fs');
+
+// setup default PDF options
+const pdfOptions = {
+  cssPath: path.join(__dirname, 'main.css'),
+  paperBorder: '2cm',
+  runningsPath: path.join(__dirname, 'runnings.js'),
+  remarkable: {
+    html: true,
+    breaks: true,
+    plugins: [classy],
+    syntax: ['footnote', 'sup', 'sub'],
+
+    highlight: (str, lang) => {
+      if (lang && hljs.getLanguage(lang)) {
+          try {
+            return hljs.highlight(lang, str).value;
+          } catch (err) {}
+        }
+
+        try {
+          return hljs.highlightAuto(str).value;
+        } catch (err) {}
+
+        return ''; // use external default escaping
+    }
+
+  }
+};
+
+// create a default config and read overrides from consumers package.json
+const contents = fs.readFileSync(path.join(process.cwd(), 'package.json'));
+const package = JSON.parse(contents.toString('utf8'));
+
+const defaultConfig = {
+  file_in: 'input.md',
+  file_out: 'output.pdf'
+};
+
+const config = Object.assign(defaultConfig, package.coderdojo_workshop_options);
+
+// convert markdown to pdf
+markdownpdf(pdfOptions)
+  .from(config.file_in)
+  .to(config.file_out);

main.css

@@ -0,0 +1,71 @@
+@import url("https://fonts.googleapis.com/css?family=Open+Sans");
+@import url('https://fonts.googleapis.com/css?family=Roboto+Slab:100,300,400,700');
+
+html, body {
+  font-family: 'Roboto Slab', serif;
+  color: #333333;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-family: 'Open Sans', sans-serif;
+  margin: 0px
+}
+
+/* First page have different H1 and H2 styles */
+h1.first-page {
+  font-size: 3em;
+  text-align: center;
+}
+
+h2.first-page {
+  font-size: 1.8em;
+  color: #888888;
+  text-align: center;
+}
+
+/* Hyperlinks have a CoderDojo green styling */
+.green {
+  color: #5b8737;
+}
+
+/* Use the .pagebreak to force a new page */
+.pagebreak {
+  page-break-after: always;
+}
+
+.underline {
+  text-decoration: underline;
+}
+
+/* Info blocks have a blue-ish color */
+.info {
+  background-color: #d6eeff;
+  border: 1px solid #86A9C2;
+  padding: 10px;
+}
+
+pre {
+  background-color: #FDF7E3;
+  border: 1px solid #f6db83;
+  padding: 10px;
+  font-size: 10px;
+}
+
+/* For bold text we're using Georgia since our Google font's bold is broken in PhantomJS */
+.bold {
+  font-family: Georgia, serif;
+  font-weight: bold;
+}
+
+/* For printing medium and small images. Often used with center */
+.medium-image { 
+  width: 70%;
+}
+
+.small-image {
+  width: 40%
+}
+
+.center {
+  text-align: center;
+}

package.json

@@ -0,0 +1,16 @@
+{
+  "name": "coderdojorotterdam-workshop-core",
+  "version": "1.0.0",
+  "description": "A basic workshop package that converts Markdown to PDF using CoderDojo Rotterdam (SF) theming",
+  "main": "index.js",
+  "bin": {
+    "core": "./index.js"
+  },
+  "author": "Tiemen Waterreus",
+  "license": "MIT",
+  "dependencies": {
+    "highlight.js": "^9.9.0",
+    "remarkable-classy": "0.0.1",
+    "markdown-pdf": "^7.0.0"
+  }
+}

runnings.js

@@ -0,0 +1,8 @@
+exports.header = null;
+
+exports.footer = {
+  height: '1cm',
+  contents: function(pageNum, numPages){
+    return '<footer style="font-size: 10px"><span style="float:right">Pagina '+pageNum+' van '+numPages+'</span></footer>';
+  }
+}