Git Product home page Git Product logo

openbases-pdf's Introduction

Open Bases Paper Base

docs/img/logo-small.png

Hi friend! ๐Ÿ‘‹

This is an automated build for a Docker container to build you a paper! If you want to use the builder for your repository, you can read full instructions at openbases/builder-pdf.

Usage

You can build your pdf locally! Here is how to look at usage:

$ docker run openbases/openbases-pdf

Usage:

         docker run <options> <container> <action> [options] ...
         docker run -v /data:/data <container> pdf

         **All input files should be mounted as volume at /data in container
         
         Action [pdf] Options:

         pdf:

             --md: pdf input markdown file (default paper.md)
             --bib: custom bib file (default paper.bib)
             --minimal: create a minimal pdf (no template, etc.)
             --logo: add a 'logo.png' to the same directory as your paper
             --name: customize the name of the resulting pdf (default paper.pdf)
             --template: use a custom template (put in mounted /data)

         pub:

             --issue: Github issue of associated review
             --year: year for publication
             --volume: volume for publication

         Examples:

              docker run -v /data:/data <container> pdf --minimal

Now since we want to generate a PDF, we would specify "pdf" as the first argument to the entrypoint. If we don't bind any folders, we can specify a demo provided in the container.

$ docker run openbases/openbases-pdf pdf 

If you want to bind the output folder to your computer to see what is generated, you can do that!

mkdir -p output
docker run -v $PWD/output:/data openbases/openbases-pdf pdf
vanessa@vanessa-ThinkPad-T460s:~/Documents/Dropbox/Code/openbases/openbases-pdf$ tree output/
output/
โ”œโ”€โ”€ paper.bib
โ”œโ”€โ”€ paper.md
โ””โ”€โ”€ paper.pdf

But likely you want to specify your own input files! Let's do that. In the folder paper in the present working directory we have a paper.md and paper.bib. Let's see if this still generates the proper output.

rm output/*
docker run -v $PWD/paper:/data openbases/openbases-pdf pdf
$ tree output/
output/
โ”œโ”€โ”€ paper.bib
โ”œโ”€โ”€ paper.md
โ””โ”€โ”€ paper.pdf

And remember that you can customize all of these variables - the default simply intends (or tries) to make this easiest for you!

  --md: pdf input markdown file (default paper.md)
  --bib: custom bib file (default paper.bib)
  --minimal: create a minimal pdf (no template, etc.)
  --logo: add a 'logo.png' to the same directory as your paper
  --name: customize the name of the resulting pdf (default paper.pdf)
  --template: use a custom template (put in mounted /data)

Development

Build the container locally. See openbases/builder-pdf for usage.

docker build -t openbases/openbases-pdf .

Have a question or need help? Please open an issue

openbases-pdf's People

Contributors

vsoch avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

forklifters

openbases-pdf's Issues

should use whedon-python helper functions

whedon-python will be a helper "python wrapper" for whedon, the idea being that we want to combine command line needs (e.g., in whedon-docker to use pandoc or interact with whedon proper) with more programmatic things like parsing yaml (from the paper.md). Python is a good choice because many users that might take advantage of the library for other purposes use Python for scientific programming.

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.