Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bonajo committed Feb 2, 2022
1 parent 0d6cd51 commit 34e1fab
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
#SeBi Theme
# SeBi Theme

This is a Hugo theme created for use in courses at Fontys Venlo.

## Structure

`Archetypes` These define the default [front matter](https://gohugo.io/content-management/front-matter/) for newly created docs/pages.

`Assets` These define the `CSS` (`SCSS`/`PostCSS`) and the `JavaScript` (`TypeScript`).

`Layouts` These define the layouts of the different pages and make sure the correct assets are included.

## Building

To build the project make sure to have the extended version of [Hugo](https://gohugo.io/) installed.

To build in development mode: `hugo server -D`
To build for production: `hugo`

## Variables

The theme defines a couple of variables that can be set under the `params` section:

- **github**: Defines the `URL` to the Github repository
- **highlight**: Whether to include [highlight.js](https://highlightjs.org/) javascript and css
- **fontawesome**: Whether to include [font-awesome v4](https://fontawesome.com/v4.7/) css and font

0 comments on commit 34e1fab

Please sign in to comment.