Git Product home page Git Product logo

kramdown-service's Introduction

kramdown-service gem - kramdown HTTP JSON API service (convert markdown to HTML or LaTeX)

Live Version

Try the markdown HTTP (JSON) API running on Heroku trykramdown.herokuapp.com.

Note: If you see an Application Error on Heroku. Sorry. It means "Free app running time quota exhausted". Please, check back in a day (or use $ kramup to run the service on your local machine). Thanks.

Start Your Own Local Version / Service

To start your own local version on your own machine use the bundled command line tool called kramup.

Step 0 - Install the gem e.g.

$ gem install kramdown-service

Step 1 - Start the server / service e.g.

$ kramup

Step 2 - Open up the editor page in your browser e.g. use http://localhost:4567.

That's it.

Usage - Web Service / HTTP (JSON) API - GET /markdown

Example 1 - Converting to Hypertext (HTML):

GET /markdown?text=Hello+World!

<p>Hello World!</p>

Example 2 - Converting to LaTeX:

GET /markdown?text=Hello+World!&to=latex

Hello World!

License

The kramdown-service scripts are dedicated to the public domain. Use it as you please with no restrictions whatsoever.

Questions? Comments?

Send them along to the wwwmake forum/mailing list. Thanks!

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.