Giter Club home page Giter Club logo

simple-blog's Introduction

Simple Blog

I wanted a very simple blog that just read markdown files and displayed them newest to oldest. I also wanted some simple templating. So I made this in a night. It uses Twig for templating and FrontYAML for parsing markdown.

Installation

  • Clone this repo to where you want your blog
  • Run composer install
  • Done

Writing blog posts

Posts live in the content folder, and should be named like url-for-post/post.md. So, a post with a URL of something-super-awesome would live in the folder content/something-super-awesome/post.md Make sure to include frontmatter in YAML format (parseable by FrontYAML) that has at least:

  • date
  • author
  • title

Templates

There are 4 templates:

  • base.html - The base template that other templates extend
  • index.html - The template that lists blog posts
  • post.html - The template that displays a single blog post
  • 404.html - The template that displays when a post can't be found

Todo

  • Add subdirectory support
  • More stuff?

simple-blog's People

Contributors

geoffoliver avatar

Stargazers

 avatar

Watchers

 avatar James Cloos 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.