Skip to content

Commit

Permalink
Add screenshots for light/dark
Browse files Browse the repository at this point in the history
  • Loading branch information
allejo committed Mar 22, 2020
1 parent a2c67bb commit 37de128
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 35 deletions.
43 changes: 8 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,19 @@
# Jekyll Docs Theme

> 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.
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.

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.
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.

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

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

## Installation
![Theme Screenshot](./screenshot.png)

Fork this project
**DarkMode**

-or-

Add this line to your Jekyll site's Gemfile:

```ruby
gem "jekyll-docs-theme"
```

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

```yaml
theme: jekyll-docs-theme
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-docs-theme
## Development
To set up your environment to develop this theme, run `bundle install`.

To develop on this theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
![Theme Screenshot](./screenshot-dark.png)

## License

The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

The theme is available as open source under the terms of the [MIT License](./LICENSE.md).
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,5 +79,6 @@ exclude:
- Gemfile
- Gemfile.lock
- jekyll-docs-theme.gemspec
- LICENSE.md
- README.md
- screenshot.png
Binary file added screenshot-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 37de128

Please sign in to comment.