Skip to content
/ ffl Public

A Language and Live Runtime for Styling and Labeling Typeset Math Formulas

License

Notifications You must be signed in to change notification settings

Penn-HCI/ffl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FFL - Formula Formatting Language

FFL is a CSS-like language that allows you to style LaTeX-typeset formula in a web environment.

How to Use

The documentation is currently limited, but doc/cheatsheet.md should give you a quick intro.

How to Run

Quick Demo

We periodically update the demo on https://penn-hci.github.io/ffl/. To run this locally,

  1. npm install in this directory
  2. cd sample/md-playground into the main demo environment with markdown integration
  3. npm install && npm run start

If all steps here are successful, you should see a react page pop up which you can experiment with. On the right side under "FFL" you will be able to enter FFL stylings.

Core Library

The root directory of this repo is the root directory of this project. It only contains the parsing and rendering of FFL and nothing on the editing environment. In src/ffl.ts you will find render and renderToHTML which emulate KaTeX, which are the main entry points for calling FFL on single formulas. An example integration can be seen in markdown-it-ffl which calls FFL to work with the markdown-it engine.

How to Contribute

The project is still in its early stages and there are major changes incoming to the implementation. If you have ideas, submit an issue in the repo. If you want to get involved, get in touch with the authors of the project and we will try our best to help get you onboard. As this project matures, this process will likely also evolve and change.

About

A Language and Live Runtime for Styling and Labeling Typeset Math Formulas

Resources

License

Stars

Watchers

Forks