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 Terminal-based package for Staticka.
License MIT
Homepage https://roug.in/staticka/console/
Informations about the package console
Staticka Console
Console is a terminal-based package of Staticka which allows creating and building of pages through a terminal.
Installation
Install the Console package via Composer:
Basic usage
To create a new page, use the create command with its title:
After adding some text to the newly created page, use the build command to compile the .md files to .html:
[!NOTE]
Consolewill try to create the required directories (e.g.,build,pages) if they do not exists in the current working directory.
Using staticka.yml
Console typically works out of the box without any configuration. But if there is a need to change the path of its other supported directories or needs to extend the core functionalities of Console, the staticka.yml file can be used in those kind of scenarios:
To create the said staticka.yml file, simply run the initialize command:
After successfully creating the said file, it will provide the following properties below:
root_path
This property specifies the current working directory. By default, it uses the %%CURRENT_DIRECTORY%% placeholder that returns the current directory of the staticka.yml file:
timezone
This allows to change the timezone to be used when creating timestamps of a new page. If not specified, Console will use the default timezone specified in the php.ini file:
assets_path
This specifies the path for all other web assets like images (.jpg, .png) and PDF files (.pdf). Console does not use this specified path but it might be useful to locate the directory for organizing asset files:
build_path
This is the property that will be used by Console to determine the destination directory of the compiled pages:
config_path
One of the properties of Console that locates the directory for storing configuration files. If defined, it will load its .php files to a Configuration class. The said class is useful when creating extensions to Console:
[!NOTE] To allow custom packages for
Console, kindly add the specified package class instaticka.yml. Please see theExtending Consolesection below for more information.
pages_path
This is the location of the generated pages from create command:
plates_path
One of the special variables of Console to specify a directory that can be used for third-party templating engines (RenderInterface):
scripts_path
This is the property for the directory path of script files (.js, .ts). Although not being used internally by Console, this property can be used when extending core functionalities (e.g., compiling .js files through Webpack when running the build command):
styles_path
Same as scripts_path, this property specifies the directory path for styling files (.css, .sass):
Extending Console
Console is based on the Slytherin PHP micro-framework which provides an easy way to integrate custom packages through IntegrationInterface. The said interface can be used to create instances related to Staticka:
To add the specified custom package, kindly add it to the staticka.yml file:
Changelog
Please see CHANGELOG for more recent changes and latest updates.
Contributing
See CONTRIBUTING on how to contribute to the project.
License
The MIT License (MIT). Please see LICENSE for more information.