Skip to content

Home

Jump to bottom
Simon Vandereecken edited this page Sep 24, 2024 · 13 revisions

Installation Guide

  1. Activate mod_headers in your Apache settings (sudo a2enmod headers & systemctl restart apache2 (thanks to @dmpop))
  2. Duplicate this repository to your desired location.
  3. Edit the config.php file (Remember to set the blog link to your final blog URL).
  4. Replace the files /assets/img/icon.png, /assets/img/author.jpg and /assets/img/og.png.
  5. Upload the entire repository to your FTP server.

For custom CSS, you can edit the file /assets/css/custom.css.

Writing Blog Posts

  1. Create a Markdown file following the format YYYY-MM-DD.md (e.g., 2023-09-27.md).
  2. Add a title property like this on top of your file with your title:
---
title: Septembre 17, 2024
---
  1. Write your content freely.
  2. Upload the markdown file to the /posts folder.
  3. Voilà! Your post is now live. The blog displays the latest post first, followed by older ones.

Adding a featured image

To add a single image post that will be featured, add a frontmatter property 'img' at the beginning of your post, after the title property

---
title: Septembre 17, 2024
img: URL TO YOUR IMAGE
---

All posts properties

The engine can uses several other properties, like this:

---
title: Your custom post title
published_date: For a date string (2024-09-23 11:09)
description: For a custom meta description
img: For a custom featured image at the bottom of the article
type: single by default, anything you want
---

The engine will always start to look for those meta and fall back to defaults if it doesn't find them. If no published_date is set, it will use the last file modification date. If no description is set, it will parse the first line of the post to generate a description.

Post types

The engine manages different post types through custom classes that are applied in list view (home & archive). You can use those to target specific type of posts in your custom CSS, for example: article.single or article.short

Creating Pages

  1. Create a Markdown file and name it as you prefer, replacing spaces with dashes (e.g., About Me becomes About-me.md).
  2. Add a title property like this on top of your file with your title:
---
title: Septembre 17, 2024
---
  1. Fill the content as desired.
  2. Upload the markdown file to the /pages folder.
  3. Your new page is now seamlessly added to the navigation.

Feel free to contribute, modify, and enhance the Tiny Blog Engine to suit your blogging needs!

If you have any questions, suggestions, or issues, please don't hesitate to open an issue or reach out.

Happy blogging!

Clone this wiki locally