Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 4.36 KB

README.md

File metadata and controls

97 lines (65 loc) · 4.36 KB
Raw

minimal-categorized logo minimal-music-project Jekyll theme

LICENSE Jekyll Gem Version Donate (Ko-fi)

minimal-music-project is a flexible, extendable Jekyll theme. With this theme it's plain simple to create a good looking website for a music band with all the required components to list all releases and news. Demo is available here.

layout examples

Installation

There are three ways to install:

  • As a ruby gem theme:

    Add this line to your Jekyll site's Gemfile:

    gem "minimal-categorized"

    And add this line to your Jekyll site's _config.yml:

    theme: minimal-categorized

    And then execute:

      $ bundle

    Or install it yourself as:

      $ gem install minimal-categorized

  • As a remote theme (GitHub Pages compatible)

    In your Jekyll site's _config.yml remove other themes and add this entry:

    remote_theme: ItsMeaga1n/minimal-categorized

  • Forking/directly copying all of the theme files into your project.

Usage

This theme uses pager plugin jekyll-paginate-v2 for pagination and jekyll-seo-tag for seo tags. It can be configured in main _config file.

Configuration via .yml files

Structure of _data/menu.yml:

  • menu_pages: a list of items in menu. Each item contains information:
    • title: Menu position title
    • url: URL for href
    • category: unique identifier of category. Used to determine which menu item is selected
    • tooltip: Tooltip for menu item
  • menu_contacts: a list of items to be displayed for a contact section in menu
    • faicon: FavIcon to be displayed in menu
    • url: URL for href
    • target: target value of <a> tag

Structure of _data/metaData.yml:

  • author: Site Author name
  • logo: relative url to the logo
  • cookies: customize information about site cookies
    • enabled: determine if should show cookies pop-up
    • message: text on cookie pop-up
    • agreeButtonText: text on agree button
    • agreeButtonFnName: function in the window scope to execute on cookie agree

Structure of _data/customs.yml:

  • custom-css: a list of urls to custom css files
  • custom-js: a list of urls to custom javascript files

Contributing

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

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in minimal-music-project.gemspec accordingly.

License

The theme is available as open source under the terms of the MIT License. Custom Volume Slider was developed with the fundaments based on codepen project, thus this component is licensed under Copyright (c) 2021 by EmNudge.