Giter Club home page Giter Club logo

transmogrify's Introduction

transmogrify

Transmogrify is a tool that converts markdown sprinkled with some Lisp to LaTeX

Documentation

Refer to the user manual. The user manual has been written using transmogrify, so user_manual.md can be used as an example

Usage

$ transmogrify <in.md> <out.tex>

Pair it with scribe to get a complete system for documenting your programs

Features

  • Single binary
  • Support for basic markdown syntax
  • Configuration using an embedded Lisp
  • Markdown extensions written in Lisp:
    • Abstract
    • Table of Contents
    • Sidenote
    • Marginnote
  • In-built support for rendering svg diagrams written in pikchr language

Dependencies

All dependencies are vendored under subprojects/. No external dependencies

Build

Transmogrify is written in C11, so you will need a C compiler that supports that standard. We are using meson with the ninja backend:

meson ninja
0.59.2 1.10.2
  1. Get the ninja binary from here
  2. Add the location of your ninja binary to your PATH environment variable
  3. Install meson
  4. Navigate to the project directory
  5. $ meson builddir
  6. $ cd builddir
  7. $ meson compile

Status

This is the first alpha release. All the above mentioned features work but we need more testing and polish to enter the beta phase. For now, stability not guaranteed

Roadmap

  1. Theming
  2. Conversion to html
  3. Conversion to plaintext
  4. More syntax extensions

transmogrify's People

Contributors

abhirag avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.