Giter VIP home page Giter VIP logo

conversio's Introduction

Conversio by Jörg Behrendt and Victor Penso

Description

Renders plain text files with Markdown syntax to XHTML pages. User can define their own Ruby ERB templates to customize the XHTML page generation. Also the creation of a table of content using the HTML header elements (like <h1>) and the syntax high-lighting of code snippets is supported.

Installation

Conversio RubyGem:

gem install conversio

Syntax high-lighting is done with Phyton Pygments:

easy_install pygments

Usage Examples

Take a look to the help text:

conversio -h

Convert all files called *.markdown inside a defined directory and all sub-directories into HTML and store them in the destination directory.

conversio ~/docs/path/to/files ~/public/path

Create a single readme.html file including a table of content by using the 'dark' template:

conversio -t -p dark readme.markdown

Syntax High-Lighting

Using the -c option syntax colorization can be enabled. Conversio will inspect all code blocks for a syntax tag in the first line. This tag needs to be part of the code block (indented with four spaces) and is prefixed with two dashes followed by the language definition. For example to high-light a code block as Ruby write --ruby as first line or for C++ --c++. If this tag is not present Conversio will not apply any high-lighting. The tag itself is passes to Pygments, therefore any language supported by it can be high-lighted.

For a list of supported languages type:

pygmentize -L lexers

License

GPLv3 - see the COPYING file.

conversio's People

Contributors

vpenso avatar dennisklein avatar

Watchers

 avatar James Cloos 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.