Giter Club home page Giter Club logo

clj-markdown's Introduction

A Clojure Markdown library.

The purpose of this library is to provide Clojure with native support for Markdown and other text-based authoring formats such as Org-mode.

Rationale

Existing Markdown implementations in other languages are available to Clojure developers but these all combine a parser front-end to Markdown with a backend emitter (ie. HTML). For these to be used in Clojure the developer has to parse the result back into Clojure structures for further processing.

A more efficient and flexible approach is to have the Markdown front-end create a native Clojure data structure (maps and vectors) that can be manipulated by functions and emitted into HTML using prxml, hiccup or a custom renderer. This also makes it easy to support other output formats, for example, DocBook XML as part of a professional publishing toolchain.

Another possibility would be to include rich text in a web application based on Compojure (hiccup).

Extensions

The overall aim is to pass all Markdown tests but while making it easier to configure and create extensions that can adapt the library to different Markdown flavors.

Performance

The library is optimised for correctness over performance. In certain cases where performance is not critical is will likely be adequate (documentation build systems). For high-performance web-pages, use a cache policy where Markdown is used for static content (i.e., generate the content once and cache it in memory).

Build

This project supports both Maven and leiningen.

Swank support is included for both systems.

Status

Currently this objective has not been reached and this library remains in a work-in-progress 'alpha' state. Once the library fully passes the entire Markdown test suite a version 1.0 will be released.

clj-markdown's People

Contributors

malcolmsparks 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.