Download the PHP package staticka/console without Composer
On this page you can find all versions of the php package staticka/console. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download staticka/console
More information about staticka/console
Files in staticka/console
Package console
Short Description An easy-to-use console application for Staticka.
License MIT
Homepage https://github.com/staticka/console
Informations about the package console
Console
A console application for Staticka. Useful for building content and templates into static HTMLs using terminal commands.
Installation
Install Console
via Composer:
Basic Usage
Create a new file by running staticka create
:
pages/hello-world.md
Then run the staticka build
command to build the files:
To see the output, open public/hello-world/index.html
in a web browser.
public/hello-world/index.html
NOTE: The result above is minified by default.
Watching files for changes
To build the website after changes are made on specified folders, run the staticka watch
in the terminal:
By default, it will watch any changes found in the pages
directory.
Adding additional data
It is possible to add additional data by adding a new property named staticka
in the composer.json
.
NOTE: $ROOT$
is a special variable that corresponds to the directory of the composer.json
file.
Filters
Filters are helpful utilities that can alter the output after being generated. Some notable examples are the HtmlMinifier
, StyleMinifier
, and ScriptMinifier
which minifies specified elements in a static page. By default, the mentioned filters were already included.
Paths
These are a list of paths that are being used by Staticka in generating static pages and also being checked for changes when using the staticka watch
command:
assets
- location of the static assets that will be copied during compilation.pages
- folder path where the Markdown templates are being stored. When creating a new page throughstaticka create
, the new file will be saved in this path.plates
- the location of the Twig templates. This can be used in updating the templates besides on the default layout.public
- where the static pages be stored after building.scripts
- location of the Javascript filesstyles
- location of the SASS files. By default, Staticka compiles SASS files and also providedBootstrap 4
SASS files out of the box.
Variables
This section contains variables that can be passed for each page being generated. This might be useful when passing global variables such as the base URL, site name, or a text that must be available in all pages.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
Credits
License
The MIT License (MIT). Please see LICENSE for more information.
All versions of console with dependencies
staticka/staticka Version ~0.1
symfony/console Version >=2.8.0
symfony/yaml Version >=2.8.0