Mercurial > piecrust2
changeset 749:171051e1aca5
docs: Very basic theme documentation.
author | Ludovic Chabant <ludovic@chabant.com> |
---|---|
date | Thu, 09 Jun 2016 22:31:42 -0700 |
parents | 6db54bed2417 |
children | 377f4b626e74 |
files | docs/docs/06_themes.md docs/docs/06_themes/01_installing-a-theme.md docs/docs/06_themes/02_creating-a-theme.md |
diffstat | 3 files changed, 44 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/docs/06_themes.md Thu Jun 09 22:31:42 2016 -0700 @@ -0,0 +1,21 @@ +--- +title: Themes +--- + +Themes let you change your website's appearance easily by applying a new set of +templates, layouts, and styles over you content. You're probably already +familiar with this concept if you're coming from some other CMS like WordPress. + +In PieCrust, themes work better if you don't have any templates -- otherwise, +you would end up mixing the theme's appearance with your own, which (unless it +was done specifically against a given theme) probably won't work well. + +Themes are really just normal PieCrust websites, but with a `theme_config.yml` +file instead of `config.yml`. You can easily install them, change them, or +create your own. + + +{% for part in family.children -%} +* [{{part.title}}]({{part.url}}) +{% endfor %} +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/docs/06_themes/01_installing-a-theme.md Thu Jun 09 22:31:42 2016 -0700 @@ -0,0 +1,14 @@ +--- +title: Installing a Theme +--- + +There are 2 ways to install a theme in PieCrust: + +1. If you have a library of themes somewhere, you can set its root directory as + your `site/themes_dirs` site config setting, and set `site/theme` as the name + of the theme you want. + +2. If you just have the one theme, you can make a link to it in your website + with the `chef themes link` command. + +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/docs/06_themes/02_creating-a-theme.md Thu Jun 09 22:31:42 2016 -0700 @@ -0,0 +1,9 @@ +--- +title: Creating a Theme +--- + +A theme is really just a normal PieCrust website, but with a `theme_config.yml` +config file instead of a `config.yml`. + +You can create a new theme by running `chef --theme init foo`. +