Code Monkey home page Code Monkey logo

al-folio-python's Introduction

al-folio-pelican

Build an academic website with the stylish look of the popular al-folio template, but using Python, not Ruby. This is a port of the al-folio template for the Pelican static site generator and the Jinja templating engine. All credit to the original authors of this fantastic template!

Want to see what the result looks like? It's almost identical to al-folio, and you can see an active version on my personal website.

Building this template has been tested (at a cursory level) on Mac OSX, Windows, and Linux.

Getting started locally

  1. Click "Use this template" at the top of the Github page to create a repository with a fresh copy of the template and a blank history.
  2. Clone the new repository to your computer and cd into it.
git clone <repo_name>
cd <repo_name>
  1. Install dependencies via pip. For interactive local development, also install invoke:
pip install -r requirements.txt
pip install invoke
  1. Build the website:
python -m invoke livereload

This command will compile the site and open a browser window that dynamically updates as you edit the content of your website. 5. Edit the content of your website. You can change config.yml, the contents of each page in the pages directory, blog posts in the articles directory, and add your list of publications in pages/publications.bib.

Debugging

Got a cryptic error message? Try running

python -m pelican --debug

which will build the website and prints log messages and a detailed stack trace for errors.

Deploying to Github Pages

Coming soon...

al-folio-python's People

Contributors

vbharadwaj-bk avatar

Stargazers

 avatar  avatar

Watchers

 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.