Giter Site home page Giter Site logo

mterzo / pelican-resume Goto Github PK

View Code? Open in Web Editor NEW

This project forked from cmenguy/pelican-resume

0.0 2.0 0.0 10 KB

A Pelican plugin to generate PDF resumes automatically from a Pelican page in Markdown

License: MIT License

Makefile 2.69% Python 76.39% CSS 20.92%

pelican-resume's Introduction

Introduction

Build Status

This is pelican_resume, a Pelican plugin enabling automatic PDF resume generation for one of your Pelican pages. The main benefit is that you only need to maintain a single Markdown version of your resume - the corresponding HTML and generated PDF are completely automated so you can showoff your awesome resume both online and physically.

It allows you write your own resume style, or use one of the styles provided by this plugin.

Installation

Installing is easy, simply run:

pip install pelican-resume

Alternatively, you can also clone this repository and install it manually:

git clone [email protected]:cmenguy/pelican-resume.git
python setup.py install

In pelicanconf.py you need to update your plugins to inclue pelican_resume:

PLUGINS = [
    # ...
    "pelican_resume",
    # ...
]

Settings

You can customize the behavior of the plugin by adding the variables below to your pelicanconf.py. For simple usage, the default values should work but will look for a specific input file and produce a specific PDF name.

Setting name Default value Usage
RESUME_SRC pages/resume.md Path to your Markdown resume page (relative to your PATH variable).
RESUME_PDF pdfs/resume.pdf Path to the generated PDF output (relative to your OUTPUT_PATH variable).
RESUME_CSS_DIR /static/css Path to the directory containing your resume CSS files.
RESUME_TYPE moderncv Type of resume to use. Has to match one of the CSS filenames under RESUME_CSS_DIR.
RESUME_PANDOC pandoc Path to your pandoc command. If pandoc is in your PATH, then it can be left as default.
RESUME_WKHTMLTOPDF wkhtmltopdf Path to your wkhtmltopdf command. If wkhtmltopdf is in your PATH, then it can be left as default.

Usage

Once you have the plugin properly configured, it will generate a PDF version of your resume automatically under the RESUME_PDF location everytime you run pelican content.

It can then easily be embedded into your Pelican website by referencing that location - thus ensuring your visitors can download the latest version of your resume which is consistent with your Markdown file.

Contributing

Contributing Guidelines

pelican-resume's People

Contributors

cmenguy avatar

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.