https://github.com/hikari-no-yume/blog

A minimal blog static site generator written in PHP
https://github.com/hikari-no-yume/blog

Last synced: 2 months ago
JSON representation

A minimal blog static site generator written in PHP

• Host: GitHub
• URL: https://github.com/hikari-no-yume/blog
• Owner: hikari-no-yume
• Created: 2014-10-07T20:34:24.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2017-12-04T10:06:59.000Z (about 7 years ago)
• Last Synced: 2024-04-14T15:09:27.580Z (9 months ago)
• Language: PHP
• Homepage:
• Size: 42 KB
• Stars: 18
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
blog

====

A minimal blog static site generator written in PHP.

Setup

-----

`composer install` will install the dependencies.

Directory layout

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

Create a `posts/` directory and fill it with `.post.md` files. I suggest naming them with the `YYYY-MM-DD-post-name` format, so they sort correctly. The first line will be used as the title.

If you want a description for the front page, create `posts/blog-description.md`.

Media files can be placed in a `media/` directory and referenced likewise in the Markdown (e.g. `![](/media/image.png)`).

Generating a site

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

`make` will populate `out/` with the generated site.

`make clean` will clear it.

Hosting a site

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

For clean URLs, this software assumes that 1) the site is hosted on the web root and 2) `.html` extensions on posts will be hidden. See `config/nginx/blog.ajf.me` for an example of how to do that..