Skip to content

Commit

Permalink
Add data about site parameters in setup section
Browse files Browse the repository at this point in the history
  • Loading branch information
gizmecano committed Mar 4, 2022
1 parent 76362f7 commit ccfd2db
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,26 @@ bin/grav clear-cache

Once this is done, the new theme should be available 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 `hereditor` folder.

--------------------------------------------------------------------------------
### Site parameters

In case _Hereditor_ theme is activated on a fresh Grav install, some parameters in the `user/config/site.yaml` file have to be populated:

1. `title`: name of your site
2. `description`: description of your site
3. `author.name`: name site owner
4. `author.email`: mail address of the site owner
5. `author.bio`: short one sentence biography

The file should look a bit like this:

```yaml
title: Website name
description: A short description for the purpose of the website
author:
name: Author Name
email: username@domain@tdl
bio: A short description of the author of the website
```

## Configuring images and links

Expand Down

0 comments on commit ccfd2db

Please sign in to comment.