Giter Club home page Giter Club logo

heroku-buildpack-pelican's Introduction

Heroku buildpack: Pelican

This is a Heroku buildpack for statically generated blogs and websites. It uses virtualenv, pip and Pelican.

Usage

Example usage:

$ ls
content/  pelican.conf.py

$ heroku create --stack cedar --buildpack [email protected]:pearkes/heroku-buildpack-pelican.git

$ git push heroku master
...
-----> Heroku receiving push
-----> Fetching custom buildpack... done
-----> Pelican app detected
-----> Preparing virtualenv version 1.6.4
       New python executable in ./bin/python
       Installing setuptools............done.
       Installing pip...............done.
-----> Installing pelican using pip version 1.0.2
-----> Bundling Apache v2.2.19
-----> Generating static content for deploy with default theme

Requirements

Content:

A content directory, with Markdown or reST files for posts. For example usage of content structure, check-out the Pelican sample.

Configuration:

A pelican.conf.py file must exist in the root directory of your project.

Themes:

For use of a custom theme, instead of Pelican's default, a theme/ directory must exist in the root. The theme/ directory should have the following structure:

├── static
│   ├── css
│   └── images
└── templates
    ├── archives.html    // to display archives
    ├── article.html     // processed for each article
    ├── categories.html  // must list all the categories
    ├── category.html    // processed for each category
    ├── index.html       // the index. List all the articles
    ├── page.html        // processed for each page
    ├── tag.html         // processed for each tag
    └── tags.html        // must list all the tags. Can be a tag cloud.

For more on themes, visit the Pelican documentation.

Local Developement

Installation:

$ pip install pelican markdown pygments docutils

Generate:

$ ls 
content/ pelican.conf.py

$ pelican . -s pelican.conf.py

Or, with a theme:

$ ls 
content/ theme/ pelican.conf.py

$ pelican . -s pelican.conf.py -t theme/

Open your generated files:

$ open output/index.html

heroku-buildpack-pelican's People

Contributors

pearkes avatar jedahu avatar

Stargazers

Lyndsy Simon avatar  avatar

Watchers

 avatar James Cloos 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.