https://github.com/michaelnordmeyer/jekyll-theme-nix
A very minimalist, single-author Jekyll theme with almost default browser styling, and a dark mode.
https://github.com/michaelnordmeyer/jekyll-theme-nix
github-pages github-pages-theme jekyll jekyll-theme minimal minimal-theme minimalism minimalist minimalistic minimalistic-theme
Last synced: 4 months ago
JSON representation
A very minimalist, single-author Jekyll theme with almost default browser styling, and a dark mode.
- Host: GitHub
- URL: https://github.com/michaelnordmeyer/jekyll-theme-nix
- Owner: michaelnordmeyer
- License: mit
- Created: 2023-02-24T13:19:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-23T21:38:22.000Z (6 months ago)
- Last Synced: 2024-12-24T02:51:56.936Z (5 months ago)
- Topics: github-pages, github-pages-theme, jekyll, jekyll-theme, minimal, minimal-theme, minimalism, minimalist, minimalistic, minimalistic-theme
- Language: HTML
- Homepage: https://jekyll-theme-nix.michaelnordmeyer.com/
- Size: 134 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Jekyll Theme Nix
A barebones theme for [Jekyll](https://github.com/jekyll/jekyll), which doesn't need any dependencies except `jekyll-redirect-from`, if you want to redirect pages without any web server configuration. It is optimized for fast build speeds as well.
Its purpose is to be a minimalist, single-author theme. Because there is no menu, pages can be manually linked in the body of `index.md`.
It also changes as little as possible from the default browser settings to improve legibility.
[Demo](https://jekyll-theme-nix.michaelnordmeyer.com/)
If this theme feels to bloated to you, you can try [“Nixer”](https://github.com/michaelnordmeyer/jekyll-theme-nixer), the ultra-minimalist version of “Nix”.
[I wrote up what inspired me to create both themes](https://michaelnordmeyer.com/i-created-two-ultra-minimalistic-jekyll-themes).
## Limited Features
- Dark mode, because we want to be respectful
- Posts
- Pages, including custom error pages
- No visible authors, categories, or tags on posts and pages
- No header or footer
- No pagination for the home page
- A feed.xml containing an Atom feed, but no JSON or outdated RSS feeds
- A sitemap.xml, because search engines should index us properly
- No semantic info like Open Graph, Twitter cards, or JSON-LD, but inline Microdata
## Minutiae
### Default Colors
The default colors are the colors of the respective browsers, both in light mode and in dark mode.
### Favicon
`icon.webp` is the favicon for the light mode, and there's also a dark variant `icon-dark.webp` for dark mode. If you want to use them, these files have to be copied manually from the demo's repository root to your site's repository root.
### Nix?
“Nix” is the grammatically incorrect form of the German “nichts”, which in English means “nothing”. It's colloquially used to stress the nothingness.
Or, if you will, it could be UNIX without the “U”, because of the theme's somewhat archaic properties.
## Installation
Installation from Gem is recommended, but using a remote theme is also possible, even though it will increase build times a little, depending on your internet connection and the size of the theme download, because it will be downloaded during each build. Gems are installed locally.
GitHub Pages gem users need to use the remote theme method.
### Installation from Gem
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-theme-nix", group: [:jekyll_plugins]
```
Then run `bundle` in your terminal.
```sh
bundle
```
Also add the theme to your Jekyll site's `_config.yml`:
```yaml
theme: jekyll-theme-nix
```
Make sure that this is the only `theme:` in `_config.yml`, and that there are no other `remote-theme:`.
### Installation as Remote Theme
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-remote-theme", group: [:jekyll_plugins]
```
Then run `bundle` in your terminal.
```sh
bundle
```
Finally add the remote theme to your Jekyll site's `_config.yml`:
```yaml
remote_theme: michaelnordmeyer/jekyll-theme-nix
```
Make sure that this is the only `remote_theme:` in `_config.yml`, and that there are no other `theme:`.
## Styled Atom Feed and Sitemap.xml
Both are included in the demo. For a standard Jekyll installation, they work out-of-the-box if the files `feed.xslt.xml` and `sitemap.xsl` are copied to the site’s Jekyll directory.
The XSLT files style the XML files. If a user selects the link to the feed, a styled version of the feed will be shown in the browser with an explainer of what web feeds are.
Because feeds are generated once, they can only support one icon. The light variant was chosen for the feed.