Giter VIP home page Giter VIP logo

librarian's Introduction

Librarian

Librarian

Static site builder and Markdown document indexer inspired by Hugo but written in PHP.

Packagist PHP from Packagist GitHub Workflow Status (main)

About

Librarian is a static site builder and Markdown document indexer inspired by Hugo but written in PHP. It uses the same format as DEV.to for markdown files with a front matter and liquid tags for custom functionality. The front matter is fluid and doesn't have a fixed spec, meaning you can include any custom fields you want and fetch them from your templates.

---
title: This Is My About Page
published: true
created_at: 2023-04-01
description: Hey there! I'm Librarian, a small file-based CMS and static site generator created in PHP, on top of Minicli.
cover_image: https://picsum.photos/780/300?r=8
---

Hey there! I'm Librarian, a small file-based CMS and static site generator created in PHP, on top of Minicli. I don't use a database, I don't have a control panel, or users. Everything is pulled from static content in my content dir.
...

Librarian default index page screenshot

Librarian doesn't use databases, sessions, or users. Administration is made from the command-line. For multiple authors, author information must be defined as metadata within the front matter.

Liquid tags supported at the moment:

Tag Example Description
audio {% audio path_to_mp3.mp3 %} embeds mp3 audio
video {% video path_to_mp4.mp4 %} embeds mp4 video
youtube {% youtube video_ID %} embeds a YouTube video
github {% github file_url %} embeds File from Github (Gists aren't supported at the moment)

Check the doc page on how to create your own custom liquid tags.

Documentation

The official documentation is available at https://librarianphp.dev. You can contribute to Librarian's documentation via GitHub.

Projects Using Librarian

  • OnLinux Systems - A blog about Linux, with tutorials and hardware reviews.
  • sponsoropensource.dev - A list of underrepresented open source creators that can be sponsored via GitHub Sponsors.
  • Librarian Documentation - The official Librarian documentation, built with Librarian.
  • Your project! Send a PR :)

Contributing

Check the Contributing Guide.

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.