README.md in jekyll-theme-doodle-5.1.7 vs README.md in jekyll-theme-doodle-5.1.8
- old
+ new
@@ -1,6 +1,6 @@
-# Doodle: A [Jekyll](https://jekyllrb.com/) theme for playful and creative aesthetic
+# Doodle: A [Jekyll](https://jekyllrb.com/) blog theme for a playful and creative aesthetic
## Table of Contents
- [Features](#features)
- [Installation](#installation)
@@ -9,10 +9,11 @@
- [Usage](#usage)
- [Pin a post](#pin-a-post)
- [Add tagline in header](#add-tagline-in-header)
- [Google analytics](#google-analytics)
- [Adding icons to naviagtion links](#adding-icons-to-naviagtion-links)
+ - [Setting default color scheme](#set-default-color-scheme)
- [Contributing](#contributing)
- [License](#license)
## Features
@@ -102,27 +103,38 @@
status: pinned
---
<!-- post content -->
```
+### Set default color scheme
+
+add the color_scheme property to \_config.yml. in the format `[light/dark]-[color]` e.g.
+
+```yaml
+color_scheme: light-green
+```
+
+following colors are available: green, blue, pink, yellow, cyan
+
### Add tagline in header
To add a tagline/description below the site title, add a tagline property to \_config.yml
```yaml
tagline: "Your awesome tagline"
```
-
### Google analytics
-add your google analytics tracking id to \_config.yml
+just add your google analytics tracking id to \_config.yml
```yaml
google_analytics: UA-NNNNNNNN-N
```
+
### Adding icons to naviagtion links
+
add the icon path to the page front matter e.g
```yaml
---
layout: page
@@ -135,10 +147,9 @@
## TODO
- [ ] Add support for comments
- [ ] Search functionality
- [ ] automatic table of contents generation (button in mobile view/ sidebar in desktop view)
-
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/gulnoor/jekyll-theme-doodle