Skip to content

moonharelabs/styless

Repository files navigation

Gem Gem GitHub deployments

Styless

A modern, highly customizable, and unstyled Jekyll theme with dark mode.

Easily hosted on GitHub Pages with few dependencies.

See it in action!

Usage

Deploy with Vercel

Dependencies

Styless is built for Jekyll, a static site generator. View the quick start guide for more information. Styless requires no special plugins and can run on GitHub Pages’ standard Jekyll compiler.

Local installation: Use the gem-based theme

  1. Install the Ruby Gem
$ gem install styless
# .. or add it to your your Jekyll site’s Gemfile
gem "styless"
  1. Add Styless to your Jekyll site’s _config.yml
theme: "styless"
  1. Run you local Jekyll server
$ jekyll serve
# .. or if you're using a Gemfile (bundler)
$ bundle exec jekyll serve
  1. Point your web browser to http://localhost:4000

Github Pages: Use the remote theme

If you're hosting your site on GitHub Pages, set up GitHub Pages and Jekyll locally so that you can more easily work in your development environment.

  1. Add Styless to your Jekyll site's _config.yml as a remote theme
remote_theme: moonharelabs/styless

You must have GitHub Pages enabled on your repo, one or more Markdown files, and a _config.yml file. See an example repository

Customize Styless

You can use any css framework with styless. Just add your libraries to _includes/custom-head.html file in your site.

Contributing

Bug reports and pull requests are welcome on GitHub at our GitHub repo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The theme is available as open source under the terms of the Unlicense License.