<div align="center"> <img src=".github/name_280.png" width="280px" alt="Markup" /> </div> <div align="center"> <strong>:turtle: Collaborate and Create :sparkles:</strong> </div> <div align="center"> Create & share TeX snippets with rich math typesetting and markdown support. </div> <br /> <div align="center">  <a href="#"> <img src="https://img.shields.io/badge/stability-beta-fcc419.svg" alt="Stability" /> </a>  <a href="#"> <img src="https://img.shields.io/badge/version-1.0.0-brightgreen.svg" alt="Version" /> </a>  <a href="#"> <img src="https://travis-ci.org/markup-app/markup.svg?branch=master" alt="Build Status" /> </a> <a href="#"> <img src="https://img.shields.io/myget/mongodb/v/MongoDB.Driver.Core.svg" alt="Mongo" /> </a>  <a href="#"> <img src="https://img.shields.io/badge/license-MIT%20Licence-blue.svg" alt="License" /> </a> </div> <div align="center"> <h3> <a href="https://markup-app.com"> Website </a> <span> | </span> <a href="https://khan.github.io/KaTeX/function-support.html"> Handbook </a> <span> | </span> <a href="https://github.com/markup-app/markup/issues"> Issues </a> <span> | </span> <a href="https://github.com/markup-app/markup/pulls"> Contributing </a> </h3> </div> <div align="center"> <sub>Built with ❤︎ by <a href="https://nickzuber.com/">Nick Zuber</a> and <a href="https://github.com/markup-app/markup/graphs/contributors"> contributors </a> </div>

Overview

Markup is a web app that lets people easily create and share rich TeX snippets. You can write snippets containing markdown and/or math typesettting - similar to the math typesetting you find in LaTeX distributions!

Write whatever you want, and hit the share button to send what you've created to your friends!

You can also save your progress and snippets locally if you want to come back to them later. We use your browser's local storage here, so keep in mind that your locally saved work is connected to your browser!

Usability

Want to get started on how to use the KaTeX math typesetting library?

Check out this handy reference guide!

Contributing

$ git clone git@github.com:nickzuber/markup.git
$ cd markup
$ npm i --no-shrinkwrap

If npm is giving you a hard time for whatever reason, try removing the lock file and reinstalling dependencies.

$ rm package-lock.json
$ npm i --no-shrinkwrap

And if that doesn't work, try using npm version 5.0.2

$ npm i -g npm@5.0.2

Setting Up

Now you want configure your host files so you can access the development site locally. Add the following to your /etc/hosts file.

127.0.0.1 markup.dev
127.0.0.1 api.markup.dev

Building

Once everything is installed, build the app with

$ npm run build:app

Developing

You generally want to build the css and app at the same time. We use hot loading with webpack.

$ npm run dev & npm run sass &

Code will recompile as you save it in real time (woo!)

License

This software is free to use under the MIT License. See this reference for license text and copyright information.

Markup

Install / Use

README