Coder Social home page Coder Social logo

suukko's Introduction

suukko

Suukko - a KISS static blog generator

Dependencies

  • GNU coreutils (bash, find, sed, date, etc.)
  • A Markdown implementation (I use Discount)

Usage

  1. Write your "about" page in about.md
  2. Put your name in static/header.html
    • Don't change "TITLE" here, it will be replaced during generation
  3. Put any additional links in static/footer.html
  4. Customize static/style.css to your preference
  5. Run make build or simply make to build the site

Blog posts are stored in subdirectories according to date, see the example in the 2017 directory. Dates are in ISO format.

The index page is both the "about" page and an archive for all your posts. If you make too many posts it will probably become unmanageable at some point.

make clean will clean up all the HTML files. make serve will serve them up on a local HTTP server, assuming you have Python installed (remember to add the .html extension if you want to view your pages, since this is designed to be served on a web server with rewriting enabled).

Choose Your Markdown

Suukko will use whatever markdown parser you like, just change the environment variable at the top of blog.sh.

suukko's People

Contributors

abbioro avatar

Watchers

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.