Contents

# jekyll-theme-miniplex

A theme for [Jekyll](https://jekyllrb.com/). Features and characteristics:

- Responsive.
- Table reformatting for very small screens.
- Hamburger menu at the bottom right, easy to reach.
- Uses the [IBM Plex](https://www.ibm.com/plex/) typeface, hence the name.

I'm using this for my personal web site, so don't expect this to fit your needs.

## What it looks like

![](screenshot.png)



## Installation

Add the following to your Jekyll site's `Gemfile`:

```ruby
gem "jekyll-theme-miniplex"

# jekyll-theme-miniplex depends on this.
gem "jekyll-titles-from-headings", "~> 0.5.3"

# Use the most recent version of jekyll-sass-converter, to force Dart Sass
gem "sass-embedded"
gem "jekyll-sass-converter", github: "jekyll/jekyll-sass-converter"
```

Add the following to your Jekyll site's `_config.yml`:

```yaml
theme: jekyll-theme-miniplex

titles_from_headings:
  enabled: true
  strip_title: true
  collections: true
```

And then execute:

    $ bundle


## Usage

### Layouts

At the moment, there is a `page` and a `post` layout, but they use the `default` layout and so are identical.

### Configuration options

To change the label of the mobile navigation menu, add this to your `_config.yml`:

```yaml
miniplex:
  mobile_nav_menu_title: "Menü"
```

## ToDos & Missing Features

- [ ] Dark mode
  - https://css-tricks.com/a-complete-guide-to-dark-mode-on-the-web/#aa-using-a-body-class
- [ ] In-page navigation
- [ ] Footer
- [ ] Maximizable tables
- [ ] Breadcrumbs, if possible
- [ ] Side notes, if possible


### Done

Most recent at the top.

- [X] Print CSS
- [X] Mobile nav bugfixing
- [X] Post author & date flexibility
- [X] Add a post's date to the page layout, or to a separate post layout


## License

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

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
jekyll-theme-miniplex-0.8.0	README.md