README

Spresso is a simple theme for Spress based on Bootstrap 3. The content is organized in one central column.

Features:

Responsive design: Supports mobile and tablets.
Disqus comments on your posts.
Support for Twitter Cards and Facebook Open Graph.
Top and bottom menu.
Social network links in the footer.
Support for Google and Bing site validation.
Code snippet highlighting with Highlight.js
Iconic font by Fort Awesome.
Sitemap and RSS feed.

Installation

You can create a site based on Spresso or install this one as a theme of a pre-existing site.

Requirements:

Spress >= 2.2.0

Creating a new site based on this theme

Perform the following command and the Spresso theme will be installed in mysite folder:

$ spress new:site mysite spress/spress-theme-spresso

Install as a theme of an pre-existing site

Go to your site folder and input the following command:

$ spress add:plugin spress/spress-theme-spresso

Then, add the following line to the config.yml file of your site:

themes:
    name: spress/spress-theme-spresso

Updating the theme

You can get the latest version of the Spresso theme by running the following command:

$ spress update:plugin

Using the theme

This theme has support for Spress themes. This feature is new in version 2.2.0

Menus

The Spresso theme supports both top and bottom menus. To configure, you can edit the top_menu and bottom_menu options from the config.yml:

top_menu:
    - { name: Home, url: / }
    - { name: About, url: /about }

    # To generate a absolute URL using site.url value:
    - { name: Docs, url: /docs, site_url: true}

bottom_menu:
    - { name: Your link, url: https://your-url }

Comments

Comments are powered by Disqus. This feature needs a disqus shortname. To get it, you need to create a account at this service. It's free. You can find out more about Disqus' shortnames here.

To enable comments, edit the config.yml of your site. Set the enabled option to true and set your disqus shortname.

# Comments in posts
comments:
    enabled: false
    disqus_shortname: ""

Disable comments in a post

If you want to publish a post without comments, set the comments variable to false at the Front-matter of the post:

---
comments: false
---
The content of my post.

License

The theme is available as open source under the terms of the MIT License.

yosymfony / spress-theme-spresso

Maintainers

Details