Skip to content

Commit

Permalink
Merge pull request #22 from caffo/back-to-top-text-readme
Browse files Browse the repository at this point in the history
Add back-to-top-text to README
  • Loading branch information
caffo committed Jul 22, 2016
2 parents 8d129c6 + 1b8168c commit c20f028
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Expand Up @@ -38,6 +38,7 @@ From there, upload the files generated in the `dist` subdirectory somewhere and
## Theme customization

There are a few options available to customize the theme at build time.
All these options are easily configurable by editing the [`theme.json`][theme-json-url] file.

| Option | Description |
| --- | --- |
Expand All @@ -47,6 +48,7 @@ There are a few options available to customize the theme at build time.
| `fancy-lists` | Whether or not to use GitHub-like task lists with checkboxes |
| `fancy-icons` | Whether or not to use icons to enhance the theme |
| `back-to-top` | Whether or not to add the "back to top" button |
| `back-to-top-text` | "Back to top" text |
| `collection` | Configuration for the collection module that is added to the content top |
| `collection.enable` | Whether or not to display the collection |
| `collection.avatar` | Optional avatar URL to be displayed alongside the title<sup>1</sup> (if none is passed, it will not be added) |
Expand All @@ -55,7 +57,6 @@ There are a few options available to customize the theme at build time.

<small>1. 35x35 is recommended</small>

All these options are easily configurable by editing the [`theme.json`][theme-json-url] file.

## Installing the theme

Expand Down

0 comments on commit c20f028

Please sign in to comment.