# lavelle/coursework

Write documents in LaTeX and Markdown
CoffeeScript Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
 Failed to load latest commit information. coffee stylus templates .bowerrc .gitignore Gruntfile.coffee bower.json changelog.md favicon.ico index.html license package.json readme.md sample.md setup.sh

# Coursework

## What is this?

Coursework is a text editor for writing technical documents, using Markdown for simple markup, and LaTeX for typesetting mathematical equations.

## What does it do?

It basically just ties together Ace Editor, Marked and MathJax and adds a couple of buttons.

## How do I use it?

Type code in the editor on the left, see results in realtime in the viewer on the right. To save files you'll need to connect to Dropbox. You can use it online or run a local copy.

One caveat if you're using the hosted version: the Dropbox API requires HTTPS URLs, which GitHub Pages doesn't support, so you'll need to put an s in the URL if you want to connect to Dropbox. This will give you a security warning.

## How do I get it?

Download this, extract it, run a server (python -m SimpleHTTPServer or something), then open the URL you're serving in the browser.

### Build from scratch

Make sure you have Git and Node installed and are on some sort of Unix, then run:

git clone https://github.com/lavelle/coursework.git
cd coursework
setup.sh


The app will not work from file:// URLs, so you must run a server. To start the inbuilt server run grunt connect. This will serve at http://localhost:8000/. If you change the port or hostname the Dropbox API calls won't work.

If this is an insurmountable problem file an issue and I'll add a new URL to the app's config. The only other valid URL right now is http://localhost/coursework/, in case you're serving your ~/code out of Apache or something.

## Why is this?

I wanted to move to an all-digital solution for taking notes in lectures. I have to write lots of equations down, so I needed something for typesetting maths, but I also wanted a clean syntax for regular markup. LaTeX and Markdown fill these roles respectively, but I couldn't find anything that let you use both, and had a realtime preview.

## Browser support

Coursework has been tested in the following desktop browsers:

• Chrome 28
• Safari 6