Skip to content

Latest commit

 

History

History
99 lines (76 loc) · 2.75 KB

README.md

File metadata and controls

99 lines (76 loc) · 2.75 KB

bibbox-website

This is the hugo app of the bibbox website. The live website is hosted on bibbox.bbmri-eric.eu

Website pages

Markdown Cheat Sheet .md cheat sheet

Changing content

For changing content, you have to change the markdown files in the content folder. You can also write native HTML in the markdown files. Put resources like images in the static folder. You can reference them in the markdown files with the following syntax:

![BIBBOX](/images/bibbox_v1.png)

Tipp: Images can be sized with the img tag in HTML.

Get started

  1. Install Hugo

MacOS:

brew install hugo
  1. Start the server
hugo server
  1. Open the browser
http://localhost:1313/

Hugo will automatically hot reload the page when you change a file.

Adding new pages

To add a new page, you have to create a new markdown file in the content folder. The file has to start with the following lines:

---
title: "Title of the page"
date: 2021-08-25T14:00:00+02:00
draft: false
include_footer: true
---

You can also create a page with the hugo cli with the following command:

hugo new <path>/<name>.md

How to change the Theme

You cannot change the themes files directly. You have to create the same file in the layouts folder and change it there. The file in the layouts folder will overwrite the file in the theme folder. Appart from 'themes/<THEME_NAME>' the file structure has to be the same as in the theme folder.

NOTE: currently all themes are hugo modules. The github theme page can be used to reference the structure of the theme.

Deployment

Manual deployment

You can manually generate the website with the following command:

hugo --minify

The website will be generated in the public folder. You can copy the files to the server or use the deploy script in the root folder. Note: this needs your ssh key to be added to the server first.

sh deploy.sh

Automatic deployment

By pushing to the main branch, the website will be automatically be build and deployed to the server via github actions.

Github action local testing

To make the CD pipeline easier to debug, the tool act can execute the github action locally. Docs: https://nektosact.com/usage/index.html Github: [https://github.com/nektos/act]

You can install act with the following command:

brew install act

You can test the github action locally with the following command:

act

As the action is using secrets, the following command executes the action with the secrets provided in the file my.secrets, formated as .env file.

act --secret-file my.secrets