Overview

AboutLibrarian is a static site builder and Markdown document indexer written in PHP, inspired by Hugo. It follows the same format as DEV.to for markdown files, utilizing front matter and liquid tags for custom functionality. Librarian does not use databases, sessions, or users and is primarily administered from the command-line. It allows for multiple authors and provides support for various liquid tags for embedding audio, video, YouTube videos, and files from GitHub.

Features

• Static site builder and Markdown document indexer
• Front matter with fluid and customizable fields
• Command-line administration
• Multiple author support
• Liquid tags for embedding audio, video, YouTube videos, and GitHub files

Installation

To install AboutLibrarian, follow these steps:

1. Clone the AboutLibrarian repository from GitHub:

git clone https://github.com/aboutlibrarian/aboutlibrarian.git

2. Change to the AboutLibrarian directory:

cd aboutlibrarian

3. Install the required dependencies using Composer:

composer install

4. Configure your site by editing the config.php file with your desired settings:

// config.php

<?php

return [
    'base_url' => 'https://example.com',
    'site_title' => 'AboutLibrarian',
    // ...
];

5. Build your site using the following command:

php bin/build

6. Your site will be generated in the build directory. You can then deploy it to your desired hosting environment.

Summary

AboutLibrarian is a static site builder and Markdown document indexer written in PHP. It offers features such as front matter with customizable fields, command-line administration, support for multiple authors, and various liquid tags for embedding media and files. It is a lightweight alternative to Hugo, allowing users to build and index static sites with ease.