Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shenlu89/jekyll-tailwindcss-starter

A dead simple, comprehensive Jekyll boilerpalte styling with Tailwind CSS.
https://github.com/shenlu89/jekyll-tailwindcss-starter

cssnano disqus google-analytics jekyll jekyll-theme mathjax postcss purgecss tailwindcss

Last synced: about 2 months ago
JSON representation

A dead simple, comprehensive Jekyll boilerpalte styling with Tailwind CSS.

Awesome Lists containing this project

README

        

# Jekyll Tailwindcss Starter

![](https://img.shields.io/github/issues/shenlu89/jekyll-tailwindcss-starter)
![](https://img.shields.io/github/forks/shenlu89/jekyll-tailwindcss-starter)
![](https://img.shields.io/github/stars/shenlu89/jekyll-tailwindcss-starter)
![](https://img.shields.io/github/license/shenlu89/jekyll-tailwindcss-starter)

A dead simple, comprehensive Jekyll boilerpalte styling with Tailwind CSS.

![](assets/images/showcase.png)

## Features

- Integrated with [Tailwind CSS](https://tailwindcss.com/) v2.2+, including [PostCSS](https://postcss.org/), [PurgeCSS](https://purgecss.com/)
- Compatiable with **Mordern Browsers** except **IE 11+**
- **Syntax Highlighting** with [Typography](https://github.com/tailwindlabs/tailwindcss-typography)
- Commenting support powered by [Disqus](https://disqus.com/)
- Optimized for search engines.
- Support **Google Analytics**
- **Latex** syntax through [Mathjax](https://www.mathjax.org/)

## Philosophy

1. Styling as simple as possible
2. Features as many as possible
3. Support modern browsers only
4. Easy to develop/refactor based on it

## Requirements

- [Node](https://nodejs.org/en/) >= 12
- [Jekyll](https://jekyllrb.com/) >= 4

## Install && Usage

```sh
# Pull down Jekyll Tailwindcss Starter
git clone https://github.com/shenlu89/jekyll-tailwindcss-starter.git
# Get into the folder
cd jekyll-tailwindcss-starter
# Install node dependencies
yarn
# Generate main.css via tailwindcss
yarn css:build
# Preview the website
yarn jekyll:serve
```

## Contributing

You want to help? Welcome to contribute:

1. [Create an issue](https://github.com/shenlu89/jekyll-tailwindcss-starter/issues/new/choose) with some constructive criticism
2. Fork it ( [http://github.com/shenlu89/jekyll-tailwindcss-starter/fork](http://github.com/shenlu89/jekyll-tailwindcss-starter/fork) )
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create new Pull Request

## License

[MIT](https://github.com/shenlu89/jekyll-tailwindcss-starter/blob/main/LICENSE)