Skip to content

Commit

Permalink
Merge pull request #4 from jmmoore/master
Browse files Browse the repository at this point in the history
English Language Improvements
  • Loading branch information
yosymfony authored May 23, 2017
2 parents 03a30d8 + 70a765d commit e46cbc0
Show file tree
Hide file tree
Showing 9 changed files with 58 additions and 55 deletions.
51 changes: 26 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,22 @@
Spresso is a simple theme for **[Spress](http://spress.yosymfony.com)**
based on Bootstrap 3. The content is organized in one central column.

See a [demo](http://yosymfony.github.io/Spress-example/).

![Spresso theme preview](/screenshot.png)

### Features:

* Responsive design: Supports mobile and tablets.
* Disqus comments on your posts.
* Support for [Twitter Cards](https://dev.twitter.com/docs/cards) and [Facebook Open Graph](https://developers.facebook.com/docs/opengraph/).
* Top and bottom menu.
* Social network links in the footer.
* Support for Google and Bing site validation.
* Code snippet highlighting with [Highlight.js](http://highlightjs.org/)
* Iconic font by [Fort Awesome](http://fortawesome.github.io/Font-Awesome).
* Sitemap and RSS feed.

See a live [demo](http://yosymfony.github.io/Spress-example/)!

## Installation
You can create a [site based on Spresso](#creating-a-new-site-based-on-this-theme-creating-site)
or install this one as a theme of a [pre-existing site](#install-as-a-theme-of-pre-existing-site-pre-existing).
Expand All @@ -16,55 +28,42 @@ or install this one as a theme of a [pre-existing site](#install-as-a-theme-of-p

### Creating a new site based on this theme

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

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

### Install as a theme of an pre-existing site

Go to your site folder and performs the following command:
Go to your site folder and input the following command:

```bash
$ spress add:plugin spress/spress-theme-spresso
```
And add this line to the `config.yml` file of your site:
Then, add the following line to the `config.yml` file of your site:

```yaml
themes:
name: spress/spress-theme-spresso
```
### How to update?
### Updating the theme
You can get the latest version of Spresso theme with just run the following command:
You can get the latest version of the Spresso theme by running the following command:
```bash
$ spress update:plugin
```

### Features:

* Responsive design: Support to mobile and tablets.
* Disqus comments on your posts.
* Support to [Twitter Cards](https://dev.twitter.com/docs/cards) and [Facebook Open Graph](https://developers.facebook.com/docs/opengraph/).
* Top and bottom menu.
* Social networks link at the footer.
* Support to Google and Bing site validation.
* Code snippets highlight.
* Iconic font by [Fort Awesome](http://fortawesome.github.io/Font-Awesome).
* Sitemap and RSS feed.

### How to use?
### Using the theme

This theme has support for [Spress themes](http://spress.yosymfony.com/docs/themes/).
This feature is new in version 2.2.0

#### Menus

Spresso support top and bottom menus. To configure, you can edit
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`:

```yaml
Expand All @@ -82,12 +81,14 @@ bottom_menu:
#### Comments
Comments are powered by [Disqus](disqus.com). This feature needs a
**disqus shortname**. To get it, you need create a account at this service.
**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](https://help.disqus.com/customer/portal/articles/466208).
To enable it, set to `true` the option `enabled` and set your disqus shortname
in the `config.yml` of your site:
To enable comments, edit the `config.yml` of your site.
Set the `enabled` option to `true` and set your disqus shortname.


```yaml
# Comments in posts
Expand Down
4 changes: 2 additions & 2 deletions config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: "Welcome to Spress"
description: "A site creted by Spress"
description: "A site created by Spress"
logo: "spresso-logo.png"

# Your site's domain. E.g: http://yoursite.com
Expand Down Expand Up @@ -55,4 +55,4 @@ top_menu:
- { name: Projects, url: "/projects" }

bottom_menu:
- { name: "Go to Spresso theme web", url: "https://github.com/yosymfony/Spress-theme-spresso" }
- { name: "Go to the Spresso theme webpage", url: "https://github.com/yosymfony/Spress-theme-spresso" }
2 changes: 1 addition & 1 deletion src/content/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: "default"
---
<div class="page-header">
<h1>Opps - Something is wrong <small>404 not found</small></h1>
<h1>Oops - Something is wrong <small>404 not found</small></h1>
</div>
<p>
Looks like that page doesn't exist.
Expand Down
6 changes: 3 additions & 3 deletions src/content/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: "page"
title: "Welcome Spresso theme"
title: "Welcome to the Spresso theme!"
list_mode: false

generator: "pagination"
Expand All @@ -16,7 +16,7 @@ <h1>Blog <small>posts</small></h1>
{% include "posts-list.html" with { posts: site.posts } %}

{% if site.posts | length < 1 %}
<p>Until now, there is no posts. :(</p>
<p>There are no posts yet. :(</p>
{% endif %}
{% else %}
{% for post in page.pagination.items %}
Expand All @@ -25,7 +25,7 @@ <h1>Blog <small>posts</small></h1>
<div class="page-header">
<h1>Welcome <small>to the blog</small></h1>
</div>
<p>Until now, there is no posts. :(</p>
<p>There are no posts yet. :(</p>
{% endfor %}
{% endif %}

Expand Down
4 changes: 2 additions & 2 deletions src/content/posts/2014-01-18-sample-post.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ HTML and <abbr title="cascading stylesheets">CSS</abbr> are our tools. Mauris a
Syntax highlighting via [Highlight.js](http://highlightjs.org/):

<div id="awesome">
<p>This is great isn't it?</p>
<p>This is great, isn't it?</p>
</div>

## Buttons

Make any link standout more when applying the `.btn` and `.btn-default` classes.
Make any link stand out by applying the `.btn` and `.btn-default` classes.

<div><a href="#" class="btn btn-default">This is a button</a></div>
4 changes: 2 additions & 2 deletions src/content/posts/2015-07-26-welcome-to-spress.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ title: "Welcome to Spress"
categories: []
tags: ["sample post", "posts"]
---
To create a new post, simply runs `spress new:post` command or adds a file
in the `./src/content/posts` folder that follows the convention `YYYY-MM-DD-name-of-post.md`.
To create a new post, simply run the `spress new:post` command or add a file
to the `./src/content/posts` folder that follows the convention `YYYY-MM-DD-name-of-post.md`.

More information about Spress:

Expand Down
13 changes: 6 additions & 7 deletions src/content/projects/config-loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,19 @@ A configuration loader with support for YAML, TOML (0.4.0) and JSON.

[![Build Status](https://travis-ci.org/yosymfony/Config-loader.png?branch=master)](https://travis-ci.org/yosymfony/Config-loader)
[![Latest Stable Version](https://poser.pugx.org/yosymfony/config-loader/v/stable.png)](https://packagist.org/packages/yosymfony/config-loader)
[![Total Downloads](https://poser.pugx.org/yosymfony/Config-loader/downloads.png)](https://packagist.org/packages/yosymfony/toml)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yosymfony/Config-loader/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yosymfony/Config-loader/?branch=master)

Installation
------------
### Installation

Use [Composer](http://getcomposer.org/) to install Config-loader package:
Use [Composer](http://getcomposer.org/) to install the Yosymfony Config-loader package:

Add the following to your `composer.json` and run `composer update`.
Add the following to your `composer.json` file and run `composer update`.

```json
```
"require": {
"yosymfony/config-loader": "1.3.*"
}
```

More informations about the package on
[Packagist](https://packagist.org/packages/yosymfony/config-loader).
More information about the package can be found on [Packagist](https://packagist.org/packages/yosymfony/config-loader).
21 changes: 12 additions & 9 deletions src/content/projects/http-server-php.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,21 @@ description: "A simple HTTP server for PHP."
---
## A simple HTTP server for PHP.

HttpServer is a simple HTTP server powerd [REACT](http://reactphp.org/).
HttpServer is a simple HTTP server powered by [ReactPHP](http://reactphp.org/).

[![Build Status](https://travis-ci.org/yosymfony/HttpServer.svg?branch=master)](https://travis-ci.org/yosymfony/HttpServer)
[![Latest Stable Version](https://poser.pugx.org/yosymfony/HttpServer/v/stable.png)](https://packagist.org/packages/yosymfony/toml)
[![Total Downloads](https://poser.pugx.org/yosymfony/HttpServer/downloads.png)](https://packagist.org/packages/yosymfony/toml)

## Installation
### Installation

Use [Composer](http://getcomposer.org/) to install Yosyfmony HttpServer package:
Use [Composer](http://getcomposer.org/) to install the Yosyfmony HttpServer package:

Add the following to your `composer.json` and run `composer update`.
Add the following to your `composer.json` file and run `composer update`.

"require": {
"yosymfony/httpserverl": "1.2.*"
}

More information about the package on [Packagist](https://packagist.org/packages/yosymfony/httpserver).
```
"require": {
"yosymfony/httpserverl": "1.2.*"
}
```
More information about the package can be found on [Packagist](https://packagist.org/packages/yosymfony/httpserver).
8 changes: 4 additions & 4 deletions src/content/projects/toml-parser-php.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ A PHP parser for TOML compatible with TOML v0.4.0.

### Installation

Use [Composer](http://getcomposer.org/) to install Yosyfmony Toml package:
Use [Composer](http://getcomposer.org/) to install the Yosyfmony Toml package:

Add the following to your `composer.json` and run `composer update`.
Add the following to your `composer.json` file and run `composer update`.

```json
```
"require": {
"yosymfony/toml": "0.3.*"
}
```

More informations about the package on [Packagist](https://packagist.org/packages/yosymfony/toml).
More information about the package can be found on [Packagist](https://packagist.org/packages/yosymfony/toml).

0 comments on commit e46cbc0

Please sign in to comment.