nmcteam/3dash

Static site generator

0.2.0 2022-06-07 17:05 UTC

This package is not auto-updated.

Last update: 2024-11-06 04:35:25 UTC


README

3dash is a tiny PHP static site generator created as a weekend project. We wanted a simple PHP solution, similar to Metalsmith, to create a tiny personal blog.

Here's the gist: there is a payload object that manages your site content and asset files. The payload object's properties are associative arrays. The array keys are pathnames of generated site files (e.g. "/about/josh.html"), and the array values are File instances that determine the content of generated site files.

The payload object is processed by a sequence of plugins. Plugins are run in the order they are added. Each plugin may manipulate the payload object. For example, a plugin may add, update, or remove site files. A plugin may also provide tools intended for subsequent plugins. The final plugin generates and outputs site files.

Documentation

Vulnerability Disclosure

If you find a security-related bug or vulnerabilty, please EMAIL US at:

security@3dash.dev

Please DO NOT disclose vulnerabilities on our public issue tracker.

Issue Tracker

Find a bug? Have suggestions? Open an issue here:

https://github.com/nmcteam/3dash/issues

Contribute

Help us improve 3dash. Contribute on GitHub!

License

3dash is released under the MIT Public License.

Authors

3dash is created and maintained by New Media Campaigns.