Skip to content

dhruvkar/stic

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

stic: a hackable static site generator script

Warning: This is the first release. It's ugly, but it works. Use at your own risk.

Why, Why, Oh Why another static site generator?

I built this partly to learn, and partly because I didn't know what type of site I wanted.

I wanted to be able modify the generator as my needs changed and didn't want to install then keep modifying a package.

A script fit the bill.


What it does

stic does three things:

  • Generates a folder structure, if it doesn't exist already. If you don't have any of folders below, it'll generate it, otherwise leave will leave the folder structure unaltered.
-public
-assets
-templates
-articles
-pages
  • Converts all .md files in the articles folder to HTML using a template in templates folder.
  • Moves all (converted) HTML files from articles and copies everything from assets & pages to the public folder.

Dependencies

  1. Python 2.7+
  2. python-markdown
  3. jinja2

Getting Started

  1. Install dependencies: pip install markdown jinja2
  2. Copy stic to the root folder of your site. i.e. right alongside the public, assets, templates, articles folders.
  3. Make it executable: chmod +x stic
  4. Run it: ./stic -t

Rules and Options

See all options by:

./stic -h

All markdown files to be converted need to have the extension .md

All templates use jinja and need to have the extension .jinja2

About

stic: a hackable static site generator script

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages