grav-theme-libretic/README.md

45 lines
2.0 KiB
Markdown

# Libretic's Deliver Theme for Grav
![Deliver](assets/readme_1.png)
This is a customization, made for [Libretic Website](https://libretic.fr), of the [Deliver theme](https://github.com/getgrav/grav-theme-deliver) which is a port of the [Deliver](http://freebiesbug.com/psd-freebies/deliver-free-psd-theme/) by [Michael Reimer](http://www.bestpsdfreebies.com/).
## Installation / Update
* Delete the `your/site/user/themes/deliver` directory.
* Download the new version of the Libretic theme from [our GIT repository](https://git.libretic.fr/libretic/grav-theme-libretic.git)
* Unzip the zip file in `your/site/user/themes` and rename the resulting folder to `deliver`.
* 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`.
> Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in `user/config/themes`) will remain intact.
# Setup
To set this theme as the default theme, follow these steps:
* Navigate to `/your/site/grav/user/config`.
* Open the **system.yaml** file.
* Change the `theme:` setting to `theme: deliver`.
* 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`.
Once this is done, you should be able to see the new theme on the frontend. Keep in mind any customizations made to the previous theme will not be reflected as all of the theme and templating information is now being pulled from the **deliver** folder.
# SCSS modifications and compilation of css
Tested on debian 10 :
```bash
apt install nodejs nmp
git clone https://git.libretic.fr/libretic/grav-theme-libretic.git
cd grav-theme-libretic
npm install # install dependancies
[ modifications of scss here ]
npm run build # build css-compiled
[git commit and push, then "setup" again in grav site]
```