Git Product home page Git Product logo

markdown-preprocessor's Introduction

Markdown Preprocessor Toolkit

Preprocessor toolkit for Markdown-to-HTML converters to parse non-standard Markdown syntax. Currently, this toolkit supports the following preprocessors:

  • Pandoc-style citation preprocessor: Parses [@key] and @key as BibTex references and adds a bibliography

The preprocessors output Markdown documents in which the non-standard Markdown is replaced by the parsed HTML code.

Installation

From within the project root, run the following command line:

pip install .

This installs the md_preprocessor package and the corresponding command-line tools.

Usage

Pandoc-style citation preprocessor

The citation preprocessor can be called from the command-line with preprocess-citations. The arguments are:

  • md_file: the file path to the Markdown file to be rendered (required)
  • --bibliography: path to CSL bibliography (optional)
  • --bibliography-marker: marker of the location within md_file where the
    bibliography should be inserted (optional, defaults to {{bibliography}})
  • -h: show usage information

The parsed markdown file is printed to stdout.

usage: preprocess-citations [-h] [--bibliography BIBLIOGRAPHY] [--bibliography-marker BIBLIOGRAPHY_MARKER] md_file

For example:

preprocess-citations --bibliography /path/to/bibliography.json /path/to/document.md > /path/to/parsed-document.md

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.