New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Proposal] Support for themes #98

yosymfony opened this Issue Dec 4, 2016 · 0 comments


None yet
1 participant
Copy link

yosymfony commented Dec 4, 2016

Themes brings to Spress the mechanic to create sites based on community-maintained templates.
Typically, themes package layouts, includes and assets in a way that can be overridden by your site content. Themes are located in src/themes/. The structure of directories for themes are the following:

|- src/
|  |- themes
|  |  |- theme01/
|  |  |- theme02/

A site could contains at least one theme. A theme is basically a site:

|- themes/
|  |- theme01
|  |  |- src/
|  |  |  |- layouts/
|  |  |  |- includes/
|  |  |  |- content/
|  |  |  |  |- assets/
|  |  |- config.yml
|  |  |-
|  |  |- screenshot.png

How to set the current template?

The current theme used by a site is defined in theme key of the config.yml file:

  name: 'theme01'

Overriding assets, layouts and includes of the theme

Spress will look first to your site’s content, before looking to the theme’s defaults for any requested file in the following folders:

  • layouts
  • includes
  • content/assets

How to create a site based on a theme?

See the new:site command.

How to create a new theme?

See the new:theme command.

@yosymfony yosymfony referenced this issue Feb 17, 2017


The roadmap of Spress 2.2.0 #95

12 of 12 tasks complete

@yosymfony yosymfony closed this May 7, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment