nmcteam/3dash

Static site generator

0.2.0 2022-06-07 17:05 UTC

Requires

• php: >=7.4
• guzzlehttp/psr7: ^2.2

Requires (Dev)

• erusev/parsedown: ^1.7
• intervention/image: ^2.7
• twig/twig: ^3.0

Suggests

• erusev/parsedown: Parse content
• intervention/image: Used by Images plugin
• twig/twig: Enables Twig templates

MIT

• Josh Lockhart

• generator
• static
• site
• static site generator

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

• Get Started
• Payload
• Files
• Plugins
  • Collections
  • Dates
  • Drafts
  • Filesystem Writer
  • Images
  • INI
  • Parsedown
  • Twig

Vulnerability Disclosure

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

[e-mail]

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.