Grav Template

A template for Grav projects to quickly get started.

Table of Contents

• Table of Contents
• Installation
  • Dependencies
  • Doppler Installation
    • Install on Windows
    • Install on Linux
    • Login
  • SASS Installation
  • Secrets
  • Auto Setup
• Development
  • Local Server
• Configuration
• Update

Installation

1. Clone the repository
2. Install dependencies
3. Install Doppler
4. Install SASS
5. Configure secrets
6. (opt) Auto Setup (to automatically install the dependencies and secrets after a pull)

Dependencies

Requirements:

• composer

Install the dependencies:

• Run IDE Task: Install Dependencies
• Run in Terminal:

  ./scripts/dependencies.sh

Doppler Installation

Requirements:

• doppler-cli
• scoop (Windows only)

Install on Windows

scoop bucket add doppler https://github.com/DopplerHQ/scoop-doppler.git
scoop install doppler

Install on Linux

(curl -Ls --tlsv1.2 --proto "=https" --retry 3 https://cli.doppler.com/install.sh || wget -t 3 -qO- https://cli.doppler.com/install.sh) | sudo sh

Login

doppler login

SASS Installation

npm install -g sass

Secrets

Requirements:

• Doppler
• UNIX system
• (alternatively) git bash

doppler setup
./scripts/secrets.sh

Auto Setup

If you pull the repo from GitHub, you can run the following command to automatically install the dependencies and secrets after a pull:

git config --local core.hooksPath .githooks/

Development

Local Server

Requirements:

• UNIX system
• (alternatively) git bash

1. Run the development server:

   bin/grav server

2. Open the site in your browser: http://localhost:8000

Configuration

• edit site config (user/config/site.yaml)
• add sitemap.xml
• edit pages (user/pages)
• edit theme (user/themes/quark-child)
  • templates
  • CSS
  • Images

Update

To update a branch with the latest changes, execute the update.sh script.