https://github.com/reactivematter/passage
A PHP based static site generator
https://github.com/reactivematter/passage
Last synced: 4 months ago
JSON representation
A PHP based static site generator
- Host: GitHub
- URL: https://github.com/reactivematter/passage
- Owner: ReactiveMatter
- Created: 2023-11-07T18:11:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-09T17:39:44.000Z (over 1 year ago)
- Last Synced: 2024-12-31T17:31:03.458Z (over 1 year ago)
- Language: PHP
- Size: 230 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is a PHP based static site generator. It is highly customizable and easy. It uses PHP for creating templates, hence no need to learn a new templating language (as PHP itself is a templating language).
It uses Parsedown and Symphony YAML component to generate static html files.
# Usage
1. Write your content in Markdown (.md) files with the directory structure as you desire. The folder path and name of the file is used as url.
2. Create template in `_template` folder. The `layout` metadata
3. Add metadata as YAML frontmatter in your files as per requirement.
4. Run `_engine/build.php` to build site. The files will be created in `_site` folder.
## Config
The sitewide config is stored in `config.yml` file. The following config options are available.
```
base: # The base for urls
title: # Site title (Alternatively if first line of the content is a heading it is used as title.)
support: [md, txt, html, htm] # File extensions which will be parsed
buildall: true # Whether to build pages without frontmatter
output-dir: _site # Output directory
default-category: General
footer: # Footer text, Implemented by template
date-format: 'd F, Y' # Date display format, Implemented by template
```
You may add more options in config file, and the value can be accessed form the $site variable.
## YAML metadata
The information about a page is to be stored in yaml frontmatter
```
title: # Title of the page
layout: # Layout to be displayed _template/.php is called for parsing
date:2023-10-30 # Date, optional
category: # category of the page
tags: # Tags array, optional
- tag1
- tag2
```
## Tags
Apart from tags metadata, tags are also detected from words stating with '#' for e.g. `#tag1`;
A line containing only tags is removed while rendering.
## Drafts
A file tagged with `draft` will not be rendered.
# Template
The presentation of the page is handled by the template. The template files resides in `_template` folder. The `_template` folder is placed in the same folder in which `_engine` is placed.
## Layout
When rendering a page, where the layout property is set, the `_template/.php` file is called. If the layout is not set, the nearest *folder name* is set as the layout. If page is in root, the value of `default-layout` set in config will be used. If `default-layout` is not set, then `page` will be set as default layout.
## Variables available inside template
`$site` variable contains all metadata contained in `config.yml` which is at the root folder in which `_engine` is placed. The variables are key of this array.
`$page` variable contains all metadata contained in frontmatter of a page. The variables are key of this array.
## Assets
All files stored in `assets` folder will be copied to `_site/assets` as it is without any processing. This is used for images, css/js files, and other resources.
## Dynamic CMS
If you need a dynamic CMS instead of SSG, try [Tunnel CMS](https://reactivematter.github.io/tunnelcms/), a dynamic counterpart of Passage.