diff options
author | Zane C. Bowers-Hadley <vvelox@vvelox.net> | 2018-09-22 11:01:37 +0300 |
---|---|---|
committer | Zane C. Bowers-Hadley <vvelox@vvelox.net> | 2018-09-22 11:01:37 +0300 |
commit | 99600c511bafcb222713f72eff9678712d217b78 (patch) | |
tree | 7d769c7d5a52ab95728ac4687066e77183dfb7b7 | |
parent | 43c16722da276b43bb82ee39f45ff29c63927776 (diff) |
start work on updating about graphing a bit
-rw-r--r-- | README.md | 36 |
1 files changed, 21 insertions, 15 deletions
@@ -17,29 +17,34 @@ Outrun with the power of a potato. Based on the Potato Dark theme with CSS bits * Outrun inspired foreground colors on a dark background, by default. * Can turn off pagination. * The ability to enable sorting of tables for pages. +* Graphing via [C3](https://c3js.org/). -Use short code for Image Zoom. +## Usage -``` -{{% zoom-img src="/images/default.jpg" %}} +Use hugo's -t dusky-neon-potato or --theme=dusky-neon-potato option with hugo commands. Example: + +```shell +$ hugo server -t dusky-neon-potato -w -D ``` -## Installation +## Shortcodes -cd your hugo site directory and run: +### Image Zoom + +Use short code for Image Zoom. -```shell -$ mkdir themes -$ cd themes -$ git submodule add https://github.com/VVelox/hugo-dusky-neon-potato.git dusky-neon-potato +``` +{{% zoom-img src="/images/default.jpg" %}} ``` -## Usage +### Graphing -Use hugo's -t dusky-neon-potato or --theme=dusky-neon-potato option with hugo commands. Example: +To enable graphing, you first need to set 'graphing_enabled' to true in frontmatter +as below. With out that, none of the shortcodes will work properly as the required +CSS and JS will not be included in the header. -```shell -$ hugo server -t dusky-neon-potato -w -D +``` +graphing_enabled = true ``` ## Configuration @@ -87,9 +92,10 @@ sort_tables: true ``` -### Colors +### Colors & Decorations -All colors stuff go under +All colors/decorations stuff go under the 'colors' config section. The +defaults are shown below. ``` [colors] |