Skip to content

Commit 37de128

Browse files
committed
Add screenshots for light/dark
1 parent a2c67bb commit 37de128

File tree

4 files changed

+9
-35
lines changed

4 files changed

+9
-35
lines changed

README.md

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,19 @@
11
# Jekyll Docs Theme
22

3-
> This is a [Jekyll theme](https://github.com/allejo/jekyll-docs-theme) based on [mistic100's modification](https://github.com/mistic100/jekyll-bootstrap-doc) of the official Bootstrap documentation from a few years back.
3+
A Jekyll theme inspired by Bootstrap's official documentation theme from a few years back. This theme started off by stealing all of Bootstrap Docs' CSS and being used in [mistic100's theme](https://github.com/mistic100/jekyll-bootstrap-doc). This theme has since be rewritten from scratch and remains solely inspired by the original design.
44

5-
Jekyll Docs Theme is provided as a theme for writing documentation for your projects instead of having a single large README file or several markdown files stored in a not so user-friendly manner.
5+
This theme is designed for writing documentation websites instead of having large unmaintainable README files or several markdown files inside of a folder in a repository.
66

7-
This theme is still in development but is kept fairly stable; just note, there are a lot things yet to come.
7+
## Screenshots
88

9-
![Theme Screenshot](https://raw.githubusercontent.com/allejo/jekyll-docs-theme/master/screenshot.png)
9+
**Light Mode**
1010

11-
## Installation
11+
![Theme Screenshot](./screenshot.png)
1212

13-
Fork this project
13+
**DarkMode**
1414

15-
-or-
16-
17-
Add this line to your Jekyll site's Gemfile:
18-
19-
```ruby
20-
gem "jekyll-docs-theme"
21-
```
22-
23-
And add this line to your Jekyll site's `_config.yml`:
24-
25-
```yaml
26-
theme: jekyll-docs-theme
27-
```
28-
29-
And then execute:
30-
31-
$ bundle
32-
33-
Or install it yourself as:
34-
35-
$ gem install jekyll-docs-theme
36-
37-
## Development
38-
39-
To set up your environment to develop this theme, run `bundle install`.
40-
41-
To develop on this theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
15+
![Theme Screenshot](./screenshot-dark.png)
4216

4317
## License
4418

45-
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
46-
19+
The theme is available as open source under the terms of the [MIT License](./LICENSE.md).

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,5 +79,6 @@ exclude:
7979
- Gemfile
8080
- Gemfile.lock
8181
- jekyll-docs-theme.gemspec
82+
- LICENSE.md
8283
- README.md
8384
- screenshot.png

screenshot-dark.png

171 KB
Loading

screenshot.png

85.3 KB
Loading

0 commit comments

Comments
 (0)