Giter VIP home page Giter VIP logo

docgen's Introduction

Documentation PDF generator

Common Usage

  1. Clone the repo
git clone ssh://[email protected]/pseudobabble/docgen.git
  1. Add a PNG header with transparent background nameddocs-header.png, replacing docs-header.placeholder.

Bare Metal Usage:

  1. Install pandoc and the requred LaTeX packages:
sudo apt install pandoc texlive-fonts-recommended texlive-latex-recommended
  1. Make the script executable
chmod +x generate_documentation_pdf.sh
  1. Run against markdown docs
./generate_documentation_pdf.sh "<<TARGET_MARKDOWN_FILE>>" "<<DOC_TITLE>>" "<<PRODUCT_AND_VERSION>>"

Example: (Path quoting avoids issues with spaces in filenames)

./generate_documentation_pdf.sh "../some_docs/Markdown Docs.md" "Document Title" "product_name 1.1.0-alpha.0""

Docker Usage

Since pandoc and LaTeX don't always play nicely with MacOS, a Dockerfile is provided.

  1. Change to repo directory
cd docgen
  1. Build the image
docker build -t docgen -f ubuntu.Dockerfile .
  1. Run against markdown docs
docker run --user `id -u`:`id -g` -v /the/directory/containing/the/documentation/markdown:/the/directory/containing/the/documentation/markdown docgen "/the/directory/containing/the/documentation/markdown/the_markdown_documentation.md" "<<DOC_TITLE>>" "<<PRODUCT_AND_VERSION>>"

There is a bash script, docker-docgen.sh, which wraps the main docker command and takes the same arguments as the bare-metal script:

chmod +x docker-docgen.sh
./docker-docgen.sh "../some_docs/Markdown Docs.md" "Document Title" "product_name 1.1.0-alpha.0""

Further Improvements

  1. Optionally obtain <<DOC_TITLE>> from the .md filename or document title
  2. Handle tables

docgen's People

Watchers

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.