README.md

Shaazzz Website

Powered by Material for MkDocs

Requirements

You need python requirements only if you want to locally serve the blog.

$ pip install -r requirements.txt

Build

Build the whole blog (including blog posts, pages, and archive page):

$ make

Preview the blog locally:

$ make serve

Remove all build files:

$ make clean

Publish a blog post

Write your blog in a markdown file (.md), inside raw/. Filename should follow this convention: YEAR-MONTH-DAY-TITLE.md. The file content looks like this.

---
blog:
    author: # author name
    date: [YEAR, MONTH, DAY, HOUR, MINUTE] # date of last modification
---

# Blog title here

Blog contents...

Add archive entry

Just edit archive.yml. The entry will be automatically added on build.