# School Report | Name | Organization | Date | |--|--| | jhtong | NUS | Feb 20, 2014 | ## Introduction ### What exactly is this? Typing LaTeX reports for short school projects is a pain. Writing Markdown's easy - but you don't get Math. This generator combines the power of Markdown - with the Math typesetting capability of $$$\LaTeX$$$. ### Why bother? I needed it for my assignments. ### Installation `generator-school-report` runs on NodeJS and Ruby. You'll also need `compass`, `coffee` and `sass`. Install `grunt`, `grunt-cli`, `bower`, and `yo`, as per the Yeoman framework. Then run: ```bash $ npm install -g generator-school-report $ mkdir my-first-report && cd $_ $ yo school-report ``` To start the server: ```bash $ grunt server ``` You've got a Live, printer-friendly school report going! To export it as a ready-to-roll HTML page, do: ```bash $ grunt ``` ### Did you say printing? Yes! `generator-school-report` comes with a printer-friendly adaptive template. Margins and colors are printed nicely, as you would in a school report. Plus, the fonts are paired for you. Just plug and play. Yay. ### What's in? - SASS / SCSS-style stylesheets - Compass / Bourbon - A stylesheet that is optimized for print, ready to roll - Live update - edit your markdown as you go - Organize your Markdown