HVL ROBOTICS WEBSITE

HVL Robotics is a research group located in Førde, Norway. This is the source of the HVL Robotics website. For more info, please contact us.

NOTE: This website is created using Minimal Mistakes Jekyll theme. Minimal Mistakes incorporates Lunr, Copyright (c) 2018 Oliver Nightingale. Lunr is distributed under the terms of the MIT License.

How to modify the website

Info

This website is created using Minimal Mistakes Jekyll Theme. The guide on how to use this theme is well explained in the Quick-Start Guide. The purpose of this page is to have a quick reference on some features which are mainly used in this website.

Important folders and files

1. _pages/: is the folder where the lecture content is stored.
2. _posts/: is the folder where the HOME page is stored.
3. _data/navigation.yaml: is the file where the left-bar (navigation bar for the website/selected content) is customized.

How to modify an existing page

The sources of this website are written in markdown syntax. There are 3 steps in modifying an existing page:

1. Find the respective file under _pages/COURSENAME.
2. Do necessary modifications either locally or via github.com
3. Save and push to GitHub. The changes will be automatically applied. You can follow the status at: GitHub Actions

How to add a new page

There are 5 steps in adding a page:

1. Find the respective folder under _pages.
2. Create the name accordingly such as COURSENAME-LECTURENAME.md
3. Copy-paste the course content header:

---
layout: single
title: "ELE306 Lesson 1"
permalink: /courses/ele306/l1
toc: true # The right side bar "on this page"
breadcrumbs: true  # the directory-of-documents type of header navigation
sidebar:
  nav: "ele306"  # the left navigation bar. Choose which category you want.
taxonomy: markup
---

1. Change the title, permalink and nav elements.

• Title: is just the name of the page. It can be chosen freely.
• Permalink: is the link to this page. By using this link in anywhere in any page, you can create a reference to this page. For consistency between notes, please keep the rule /courses/courseXXX/lX for lecture notes, /courses/courseXXX/aX for assignments and /courses/courseXXX/labX for lab exercises.
• Navigation: is the category of this page belong to. This tag is important for the left navigation bar and _data/navigation.yml

1. Add the title and the permalink under the respective parent folder in _data/navigation.yml.

- title: "ELE306 Lesson-X"
  url: /courses/ele306/lX

Where to edit files

You can edit files either locally or via github.com.

Local Edit

1. You need jekyll installation. The steps are in the link.
2. You need to clone the source codes of this website.

• if it is the first time, you need to run bundle install via CMD terminal under the downloaded folder. (Your local directory for the website /hvl_robotics_website)

1. Do the desired changes in the respective _pages/XXX.md files.
2. If you want to see the changes before pushing to the cloud, you need to run bundle exec jekyll serve. The changes will immediately apply at http://127.0.0.1:4000/ or http://localhost:4000/.

via github.com

You don't need any installation for this method.

1. Browse to the page that you want to edit on GitHub.
2. Click edit this file button on the right-top corner.
3. Do the desired changes.
4. Save and push changes.

Important files

{: .notice--info} This section is for advanced users.

• All the source files are under _pages/. 99% of the time, you don't need to browse anywhere else than this.
• If you want to modify things on the Home page: _posts/2023-06-24-home.md
• The source code of this webpage: _posts/2023-06-24-how-to-modify.md
• The _config.yml file and Gemfile are responsible in all kind of dependencies and settings. The details can be found here.

Useful links

• Markdown cheat-sheet.
• Minimal mistakes theme source code: https://github.com/mmistakes/minimal-mistakes
• Tags and formatting: https://mmistakes.github.io/minimal-mistakes/markup/markup-html-tags-and-formatting/

TODO:

• ROS submodule.
• Most used markdown features in this website.