SeaCMS/pico
3
0
Fork 0
Code Issues Pull Requests Activity

Update inline doc

Browse Source
This commit is contained in:
Daniel Rudolf 2015-08-01 22:38:14 +02:00
parent 6e8bc85a8b
commit f90e3b4472
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
config/config.php.template
View File

@ -11,8 +11,8 @@
* @license http://opensource.org/licenses/MIT * @license http://opensource.org/licenses/MIT
* @version 0.9 * @version 0.9
* *
* To override any of the default settings below, uncomment the line, * To override any of the default settings below, copy this file to
* make and save the changes, then rename this file to `config.php` * `config.php`, uncomment the line and make and save your changes.
*/ */
/* /*

11
content-sample/index.md
View File

@ -55,16 +55,16 @@ There are also certain variables that you can use in your text files:
You can create themes for your Pico installation in the "themes" folder. Check out the default theme for an example of a theme. Pico uses You can create themes for your Pico installation in the "themes" folder. Check out the default theme for an example of a theme. Pico uses
[Twig](http://twig.sensiolabs.org/documentation) for it's templating engine. You can select your theme by setting the `$config['theme']` variable [Twig](http://twig.sensiolabs.org/documentation) for it's templating engine. You can select your theme by setting the `$config['theme']` variable
in config.php to your theme folder. in `config/config.php` to your theme folder.
All themes must include an `index.html` file to define the HTML structure of the theme. Below are the Twig variables that are available to use in your theme: All themes must include an `index.html` file to define the HTML structure of the theme. Below are the Twig variables that are available to use in your theme:
* `{{ config }}` - Conatins the values you set in config.php (e.g. `{{ config.theme }}` = "default") * `{{ config }}` - Conatins the values you set in `config/config.php` (e.g. `{{ config.theme }}` = "default")
* `{{ base_dir }}` - The path to your Pico root directory * `{{ base_dir }}` - The path to your Pico root directory
* `{{ base_url }}` - The URL to your Pico site * `{{ base_url }}` - The URL to your Pico site
* `{{ theme_dir }}` - The path to the Pico active theme directory * `{{ theme_dir }}` - The path to the Pico active theme directory
* `{{ theme_url }}` - The URL to the Pico active theme directory * `{{ theme_url }}` - The URL to the Pico active theme directory
* `{{ site_title }}` - Shortcut to the site title (defined in config.php) * `{{ site_title }}` - Shortcut to the site title (defined in `config/config.php`)
* `{{ meta }}` - Contains the meta values from the current page * `{{ meta }}` - Contains the meta values from the current page
* `{{ meta.title }}` * `{{ meta.title }}`
* `{{ meta.description }}` * `{{ meta.description }}`
@ -100,8 +100,9 @@ See [http://pico.dev7studios.com/plugins](http://picocms.org/plugins)
### Config ### Config
You can override the default Pico settings (and add your own custom settings) by editing config.php in the root Pico directory. The config.php file You can override the default Pico settings (and add your own custom settings) by editing `config/config.php` in the Pico directory.
lists all of the settings and their defaults. To override a setting, simply uncomment it in config.php and set your custom value. The `config/config.php.template` lists all of the settings and their defaults. To override a setting simply copy
`config/config.php.template` to `config/config.php`, uncomment the setting and set your custom value.
### Documentation ### Documentation