typeotter

Create documents with great typesetting on the web.

---

TypeOtter is a Javascript library to render high quality typesetting in html and pdf.

This library is intended as an improvement on LaTex, allowing users to write professional documents in markup.

Installing

$ npm install typeotter

or

Download compressed: TypeOtter-0.2.0.zip

or

Just link it, no download!(see example)

Setup and Features

--> CodePen Showcase: Setup, syntax, math, typesetting, support

Developers

Make sure you have node installed

Install gulp (use sudo if it doesn't work)

$ npm install -g gulp

Install node modules (use sudo if it doesn't work)

$ npm install

Compile js and scss files

$ gulp

Run tests command and open your browser

$ npm test

Contributions

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request 😄

Sources

• Basic Rules of Good Typography

Dependencies

• jQuery --> jQuery write less, do more
• Font --> Computer Modern on the web by CheckMyWorking.com
• Math --> MathJax, Beautiful math in all browsers
• Icons --> Font Awesome, The iconic font and CSS toolkit
• CSS modules --> Pure CSS, A set of small, responsive CSS modules that you can use in every web project
• Spinner --> #Codevember - Day 6 - Bookshelf loader by Grélard Antoine
• CSS Normalize --> Normalize.css, A modern, HTML5-ready alternative to CSS resets
• Download file --> download by dandavis
• Code rendering --> GitHub gist

Special Thanks

• Frederik Madsen for inspiration and help with some of the code
• Anders Munck Højsgaard for feedback and discussions

---

Copyright © 2016 Mathias Grundtvig Andreasen (MGApcDev). Licensed under the terms of the GPLv3 license.