Download the PHP package slogsdon/flat-file without Composer
On this page you can find all versions of the php package slogsdon/flat-file. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download slogsdon/flat-file
More information about slogsdon/flat-file
Files in slogsdon/flat-file
Package flat-file
Short Description Fast static-site generator / flat-file CMS
License MIT
Informations about the package flat-file
flat-file
Fast static-site generator / flat-file CMS
Features
- Needs zero configuration
- Uses Markdown, HTML, or PHP
- Routes based on file system
- Exports static sites, or runs via PHP powered web servers
- Includes development environment
Reasoning
PHP is easy to install, if not already present on you computer. PHP runs pretty much everywhere. PHP is flexible.
This project also scratches an itch to see how much PHP can handle in this problem domain.
Requirements
Getting Started
The scripts
and config
sections are not required, but they do help simplify the development process. If using the start
script, the process-timeout
configuration option allows Composer to run a script for longer than the default timeout (300 seconds).
If not using Composer script configurations, you'll need to reference the flat-file
script as vendor/bin/flat-file
, e.g.:
After setting up your composer.json
file, don't forget to pull down your dependencies:
Adding Content
Next, your individual pages need to be included in a pages
directory at the root of your project (i.e. next to your composer.json
file). Pages can be written in Markdown (with the .md
or .markdown
file extension), plain HTML, or PHP (with the .php
file extension). PHP files have the option of outputing the content as normal (echo, print, content outside of ` tags, etc.) or returning the content as a string (
<?php return 'hello world';`).
Add more pages with new files under pages
, e.g.:
Running the Development Server
Ready to test? Spin up the development server:
This will start a PHP development server listening on http://localhost:3000
. Pressing Ctrl-C
will stop the server, freeing the way for building your project to plain HTML files for later deployment.
Building Static Files
Kick off a build of the site:
Ignoring Composer's vendor
directory, you should see something similar to below in your project root once all is said and done:
Using a Custom Entrypoint
By default, we provide an entrypoint for the webserver to use when serving requests. It completes some rewrites for files in public
, requires the Composer autoloader, and kicks off the application. You can elect to include your own by creating a new entrypoint named index.php
and put it in the public
directory at the root of your project. Here's the default one for reference:
Running as a Flat-File CMS
If you wish to run your project with a PHP-enabled web server as a flat-file CMS instead of a static site, you'll want to:
- Configure your web root to be
public
- Use a custom entrypoint or configure your web server to have
vendor/slogsdon/flat-file/src/router.php
serve any non-existent paths.
Your web server will then be able to serve static assets from public
as it normally would and also any pages you create.
F.A.Q.
- What about LiveReload like functionality?
- That's being investigated, but use
F5
/Cmd-R
for the time being.
License
This project is licensed under the MIT License. See LICENSE for details.
All versions of flat-file with dependencies
league/commonmark Version ^0.17.5
spatie/yaml-front-matter Version ^2.0
symfony/console Version ^4.1