Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 3.64 KB

README.md

File metadata and controls

91 lines (69 loc) · 3.64 KB
Raw

Gem Gem GitHub deployments

Jwind

Tailwindcss based Jekyll theme.
Rapidly build modern websites with Jekyll.

See it in action!

Getting started

Dependencies

Jwind is built for Jekyll, a static site generator. View the quick start guide for more information. Jwind requires no special plugins and can run on GitHub Pages’ standard Jekyll compiler. The Jekyll SEO Tag plugin is included by default (no need to run any special installation) to inject SEO and open graph metadata on docs pages. For information on how to configure SEO and open graph metadata visit the Jekyll SEO Tag usage guide.

Quick start: Use as a GitHub Pages remote theme

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

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

Local installation: Use the gem-based theme

  1. Install the Ruby Gem
$ gem install jwind
# .. or add it to your your Jekyll site’s Gemfile
gem "jwind"
  1. Add Styless to your Jekyll site’s _config.yml
theme: "jwind"
  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

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.

Customize Styless

Dark Theme

Styless has a built-in dark theme. Styless automatically selects dark theme, if browser users selected darkt theme from system settings. But you can easily toggle it.

  • Enable
<button onclick="document.documentElement.classList.add('dark');">Enable Dark Theme</button>
  • Disable
<button onclick="document.documentElement.classList.remove('dark');">Enable Dark Theme</button>
  • Toggle
<button onclick="document.documentElement.classList.toggle('dark');">Enable Dark Theme</button>

About the project

Jwind is © 2021-now by @ksengine.

License

Jwind is distributed by an Unlicense License.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Read more about becoming a contributor in our GitHub repo.

Code of Conduct

Jwind is committed to fostering a welcoming community.

View our Code of Conduct on our GitHub repository.