Skip to content

Commit 24a2b58

Browse files
committed
Add screenshot
1 parent a40b461 commit 24a2b58

File tree

2 files changed

+51
-3
lines changed

2 files changed

+51
-3
lines changed

README.md

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,20 @@ A dark theme for Jekyll, inspired by Dash UI for Atom. 🌒
88
---
99
This theme for [Jekyll](https://jekyllrb.com/) has been inspired by [dash-ui](https://atom.io/themes/dash-ui), a dark theme for [Atom](https://atom.io).
1010

11+
![design](screenshot.png)
12+
1113
## Installation
1214

1315
Add this line to your Jekyll site's `Gemfile`:
1416

1517
```ruby
16-
gem "dash"
18+
gem "jekyll-dash"
1719
```
1820

1921
And add this line to your Jekyll site's `_config.yml`:
2022

2123
```yaml
22-
theme: dash
24+
theme: jekyll-dash
2325
```
2426
2527
And then execute:
@@ -28,7 +30,53 @@ And then execute:
2830
2931
Or install it yourself as:
3032
31-
$ gem install dash
33+
$ gem install jekyll-dash
34+
35+
## Configuration
36+
37+
Add the following configuration to your site. Customise it to your needs!
38+
39+
```yaml
40+
# jekyll-paginate
41+
paginate: 5
42+
paginate_path: "/blog/page:num/"
43+
44+
# jekyll-tagging (optional)
45+
tag_permalink_style: pretty
46+
tag_page_layout: tag_page
47+
tag_page_dir: tag
48+
49+
dash:
50+
date_format: "%b %-d, %Y"
51+
52+
disqus:
53+
shortname: <your-discuss-shortname>
54+
55+
# generate social links in footer
56+
# supported colors: green, red, orange, blue, cyan, pink, teal, yellow, indigo, purple
57+
social_links:
58+
- url: https://twitter.com/bitbrain_
59+
icon: twitter-square
60+
color: cyan
61+
- url: https://bitbrain.itch.io
62+
icon: itch-io
63+
color: red
64+
- url: https://github.com/bitbrain
65+
icon: github-square
66+
color: purple
67+
```
68+
69+
## Additional Features
70+
71+
**Tagging** add the `jekyll/tagging` plugin to your `_config.yml` file to enable tagging. Do not forget to also add the following to your `Gemfile`:
72+
```Gemfile
73+
gem "jekyll-tagging"
74+
```
75+
**Gravatar** if you want to display your gravatar picture, add the `liquid-md5` to your `_config.yml` file. Do not forget to also add the following to your `Gemfile`:
76+
```Gemfile
77+
gem "liquid-md5"
78+
```
79+
**
3280

3381
## Contributing
3482

screenshot.png

77.3 KB
Loading

0 commit comments

Comments
 (0)