https://github.com/ospii/oblog

Simple php blog, Markdown + Twig => HTML + sitemap.xml
https://github.com/ospii/oblog

html-generator markdown markdown-twig php static-site-generator

Last synced: 7 months ago
JSON representation

Simple php blog, Markdown + Twig => HTML + sitemap.xml

• Host: GitHub
• URL: https://github.com/ospii/oblog
• Owner: ospii
• License: mit
• Created: 2015-03-12T07:26:26.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-09-10T08:35:25.000Z (almost 2 years ago)
• Last Synced: 2024-09-10T10:52:40.477Z (almost 2 years ago)
• Topics: html-generator, markdown, markdown-twig, php, static-site-generator
• Language: PHP
• Size: 12.7 KB
• Stars: 1
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Oblog - Markdown to HTML

========================

This is a simple Markdown + Twig => HTML + sitemap.xml script. It will read source markdown files from a directory, natural sort the files, pass them through Twig templates and write output into given directory.

The script will also generate a sitemap to `sitemap.xml` and atom feed to `atom.xml`.

Usage

-----

See the example site in `/example` directory. Sample has two public posts and one draft. To generate posts run the following

    php gen.php

**Warning! All files with `.html` extension in output directory will be deleted**

First line of the source markdown file has several **magical** properties:

* it will be used as part of the html filename eg. "Laihduta regexillä" would be named "laihduta-regexilla.html".

* if it contains `+DRAFT+`, the post won't be added to link list nor `sitemap.xml` and is given a slightly obfuscated filename which is only shown during HTML generation.

via Composer

------------

    {

        "require": {

            "ospii/oblog": "dev-master"

        }

    }