irs/sat-sw-website
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added instructions to add a page

Browse Source
This commit is contained in:
Robin Müller 2023-12-11 15:46:39 +01:00
parent 5c4b7c7927
commit a21ef637c3
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -32,3 +32,28 @@ The website can be built into the `public` folder by running
```sh
hugo
```
## Adding a page
A new page can be added by adding a new page (bundle) inside the projects directory by creating
a new folder inside the `/content/projects` directory containing an `index.md` or `_index.md`.
The home page will display the summary parameter of the page bundle front matter. A small logo
used for the homepage display can be specified in the front matter by adding a `logo` page
resource and specifying the image source relative to the diretory. Custom CSS has to be
specified via the `homeLogoCss` variable as shown in the block below:
```toml
homeLogoCss = "satrs-img"
[[resources]]
name = "logo"
src = "sat-rs_logo.png"
```
Alternatively, you can specify a text only header using the `homeSummaryHeader` parameter:
```toml
homeSummaryHeader = "spacepackets"
```
The home page template found in `layouts/index.html` will collect all pages inside the
`content/projects` folder and render them accordingly.