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

Add comments to pico-theme.yml and mention it in README.md

Browse Source
This commit is contained in:
Daniel Rudolf 2019-11-23 19:19:35 +01:00
parent dcd8ebe723
commit 2e5abc386d
No known key found for this signature in database
GPG Key ID: A061F02CD8DE4538
2 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -40,7 +40,7 @@ Anyway, since Pico's default theme is meant to be a starting point for your own
```yaml ```yaml
--- ---
social: Social:
- title: Visit us on GitHub - title: Visit us on GitHub
url: https://github.com/picocms/Pico url: https://github.com/picocms/Pico
icon: octocat icon: octocat
@ -50,6 +50,8 @@ social:
--- ---
``` ```
You should also check out the theme's `pico-theme.yml`: First of all it tells Pico to use the latest API version for themes and adjusts Pico's default Twig config. But more importantly it also registers the mentioned `widescreen` theme config as well as the meta header `Social`.
Getting Help Getting Help
------------ ------------

15
pico-theme.yml
View File

@ -1,11 +1,12 @@
api_version: 3 api_version: 3 # Use Pico's latest API version for themes
meta: meta: # Register meta headers used by this theme
Social: social Social: social # A list of social icons that will be shown in your website's footer;
# You must specify a "title", "url" and "icon" per entry
twig_config: twig_config: # Twig template engine config
autoescape: html autoescape: html # Let Twig escape variables by default
strict_variables: false strict_variables: false # If set to true, Twig will bail out when unset variables are being used
charset: utf-8 charset: utf-8 # The charset used by Twig templates
widescreen: false # Use more horicontal space (i.e. make the site container wider) widescreen: false # Use more horicontal space (i.e. make the site container wider)