Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exaluc/boucle
Jekyll theme for simple blog with tailwindcss
https://github.com/exaluc/boucle
css generator gh-pages gh-pages-site html jamstack javascript jekyll kiss ruby static tailwindcss theme
Last synced: 24 days ago
JSON representation
Jekyll theme for simple blog with tailwindcss
- Host: GitHub
- URL: https://github.com/exaluc/boucle
- Owner: exaluc
- License: mit
- Created: 2023-07-24T01:48:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-01T15:27:23.000Z (about 1 year ago)
- Last Synced: 2024-09-29T14:01:33.215Z (about 1 month ago)
- Topics: css, generator, gh-pages, gh-pages-site, html, jamstack, javascript, jekyll, kiss, ruby, static, tailwindcss, theme
- Language: HTML
- Homepage: http://loop.brain.fr/boucle/
- Size: 136 KB
- Stars: 11
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Boucle
Boucle is an elegant and modern theme for Jekyll, crafted with Tailwind CSS. It's designed for flexibility, easy customization, and supports tags, categories, SEO, pagination, and more. The theme also features a custom JavaScript search functionality which can filter posts by title.
## Installation
To install the Boucle theme on your Jekyll site, follow these steps:
1. Download or clone this repository
```
$ git clone https://github.com/exaluc/boucle.git
```
2. Set the configs vars in your Jekyll site's `_config.yml`
3. Build your site:
```bash
$ bundle exec jekyll serve
```
## Features
- **Modern Design**: Boucle is designed with a clean and modern aesthetic in mind, crafted with Tailwind CSS.
- **Search Functionality**: Custom JavaScript is used to allow users to search for posts by their titles.
- **Support for Tags and Categories**: Boucle provides built-in support for post tags and categories.
- **SEO Ready**: The theme has been optimized for search engines.
- **Pagination**: Pagination is built into the theme for ease of navigation.
## Usage
After installing the theme, you can customize it to suit your needs. Boucle provides a number of configuration options that are detailed below:
| Key | Example Value | Description |
|-------------------------|----------------------------------|-----------------------------------------------|
| `title` | "boucle ∞" | Your site's title. |
| `email` | "[email protected]" | Your email address. |
| `description` | "Awesome description" | The description of your site. |
| `baseurl` | null | The subpath of your site, e.g. `/blog` |
| `url` | "" | The base hostname & protocol for your site. |
| `twitter_url` | "example_site" | Your Twitter page URL. |
| `github_url` | "example_site" | Your GitHub page URL. |
| `linkedin_url` | "example_site" | Your LinkedIn page URL. |
| `menu_categories` | ["devops", "linux", "data", "network"] | The categories you want to show in the menu.|
| `permalink` | '/:title/' | The permalink structure you want to use for your posts. |
| `author.name` | 'Lucian' | The author's name. |
| `author.image` | 'https://...' | The URL to the author's image. |
| `author.description` | 'Open source enthusiast.' | The author's description. |
| `author.twitter` | 'exaluc' | The author's Twitter handle. |
| `author.github` | 'exaluc' | The author's GitHub username. |
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/exaluc/boucle. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/exaluc/boucle/blob/main/CODE_OF_CONDUCT.md).
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Boucle project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/exaluc/boucle/blob/main/CODE_OF_CONDUCT.md).
## Author
- [Lucian BLETAN](https://github.com/exaluc)
Distributed under the MIT license. See ``LICENSE`` for more information.
[Boucle](https://github.com/exaluc/boucle)