Giter Club home page Giter Club logo

doc-generator's Introduction

Raven PDF Generator

This project aims to facilitate the creation of Raven stylized PDF files from Markdown.

It uses Pandoc with a modified template from this one.

Requirement

Dependencies:

  • Python3
  • Pandoc

Run the following command to download the required python modules:

pip install -r ./requirement.txt

Howto

To generate a pdf document from a markdown file:

./doc-generator.py -f input.md output.pdf

To generate a pdf document from an url:

./doc-generator.py -u http://input.md output.pdf

The document must start with some metadata that must follow this pattern:

---
title: "Document Title"
accountant: [John Doe]
version: 1.0.0
history: [
        {
                author: "John Doe",
                date: "27 Oct 2017",
                version: "1.0.0",
                sections: "All document",
                comments: "Fixed some typos",
        },
        {
                author: "John Doe",
                date: "28 Oct 2018",
                version: "1.1.0",
                sections: "1.3",
                comments: "Added section 1.3: installation guide",
        },
]
lang: fr-FR
...

The document can contain an abstract between the Abstract and EndAbstract headers:

#Abstract

This is the abstract of the document

#EndAbstract

#1. Part One

Content of part one

Bugs?

Did you find any bugs? Feel free to fill an issue!

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.