Giter Club home page Giter Club logo

grav-theme-gravtail's Introduction

Gravtail Theme

The Gravtail Theme is made for Grav CMS.
Please note that the purpose of this theme is to be just a demo of using Tailwindcss for Grav CMS. If you have feedback or suggestions for improvement, please open an issue first, so we can discuss the change.

Description

This grav theme uses the Tailwindcss framework and is based on the landing page made bij Tailwindtoolbox.com

Pictures of the demo by Undraw, logo icon by freepik from Flaticon

Tailwind

Tailwind files are no longer added in the vendor/tailwindcss directory, but can easily be installed via npm - see paragraph "Extending Tailwindcss" For more information about Tailwindcss please refer to the documentation of Tailwindcss

Extending Tailwindcss

If you want to extend tailwind css using your own classes, you can do so by adapting the base.css file and/or the tailwind.config.js file.
First you will need to install tailwindcss and dependencies. Navigate with a CLI tool to the gravtail directory and run npm install. You can now adapt the above mentioned files and recreate the gravtail.css file using CLI command npm run build which shortcuts to "npx tailwindcss build css/base.css -o css/custom.css".
Do not forget to empty caches to see the result.
Please refer to the Tailwindcss docs for more information.

Installation

GPM Update

Currently not supported as gravtail is not listed yet.

Manual installation

To install this theme, just download the zip version of this repository and unzip it under /your/site/grav/user/themes. Then, rename the folder to gravtail.

You should now have all the theme files under the gravtail directory

Setup

If you want to set gravtail theme as the default theme, you can do so by following these steps:
if you have the admin panel installed:

  • go to themes and click on the activate button under the theme name

Without the admin panel:

  • Navigate to /your/site/grav/user/config.
  • Open the system.yaml file.
  • Change the theme: setting to theme: gravtail.
  • Save your changes.
  • Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in Terminal and typing bin/grav clear-cache.

Configuration

The theme has several configuration settings for the social links, the terms & condition link, the company address. They can easily be accessed in the admin panel by clicking on the theme picture.
Without the admin panel the parameters have to be filled in manually in the gravtail.yaml file.
The names of the different parameters can be found in the blueprint.yaml file of the theme.

Demo

Demo can be found here.

grav-theme-gravtail's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

grav-theme-gravtail's Issues

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.