Skip to content

A theme for the static website generator Pelican heavily inspire by Modernist

License

Notifications You must be signed in to change notification settings

broke/O-S--Theme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Introduction

A theme for the static website generator Pelican heavily inspire by Modernist

Usage

Dependencies to use Pelican

  • Pelican

$ sudo pip install pelican

  • Pelican plugins

$ git clone --recursive https://github.com/getpelican/pelican-plugins

Run the command above in project root

  • Markdown

$ sudo pip install markdown

  • webassets

$ sudo pip install webassets

  • cssmin

$ sudo pip install cssmin

  • SASS

$ gem install sass

Make sure gem bin directory is in your $PATH

Theme dependencies

  • CSS/SCSS
    • normalize
    • bourbon
  • MathJax
  • jQuery

Update theme dependencies

$ gem install bourbon

$ bourbon install --path theme/O(S)/static/css/

  • MathJax

    $ sudo npm install -g grunt-cli

    $ npm install

    • Run gruntfile to reduce MathJax size

    $ grunt

    • Remove Gruntfile.js and node_modules in theme/O(S)/static/js/MathJax

Run

Generate blog

  • To get your final blog run

$ pelican content -o output -s publishconf.py

  • To get an live preview on your local machine run the following in parallel

$ pelican -r content -o output -s pelicanconf.py

$ cd output && python -m pelican.server

Your blog can now be previewed on http://localhost:8000

TODOs

Important

  • config lines for foooter button
  • Markdown listing in list gets indetation and breaks
  • fix footnote is indented by 40px by default (bad fix right now)
  • fix huge margins between entries in footnote (bad fix right now)
  • Menu for pages and option in config to hide/show menu

Credits

Credits to Steve Smith for his Modernist theme where most of the inspiration for this theme comes from. Thanks to Atle Mo for his beautiful collection of patterns used for the background image.

About

A theme for the static website generator Pelican heavily inspire by Modernist

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published