Git Product home page Git Product logo

boucle's Introduction

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:

    $ 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.

License

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

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.

Author

Distributed under the MIT license. See LICENSE for more information.

Boucle

boucle's People

Contributors

exaluc avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

znu

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.