Skip to content

Home

Jump to bottom
Julian Trommer edited this page Sep 9, 2024 · 6 revisions

UNA-AuxMe Website for Student Projects and Theses

This wiki will guide you through the process of adding a topic to the overview.

Prerequisites

If you want to test the site locally you need to:

  1. Install Jekyll.

It is recommended to use Bundler to install Jekyll. For this you need to install Ruby first.

  1. Clone the repository.
  2. Navigate to the folder of the repository.
  3. Install the necessary Ruby gem dependencies with: 
    bundle install
  4. Run the website locally with: 
    bundle exec jekyll serve

You should be able to reach the website at http://127.0.0.1:4000/ now.

If you run into an error regarding webrick you can manually install the package with:

bundle add webrick

Adding new topics

If you want to add new topics to the site the two folders that are used are

  • topics for the displayed text and
  • assets for additional resources.

assets folder

The assets folder can be used to store additional files for your topic. This includes for example the image that is displayed with your text or additional information that can be linked in your topic (more on that in the topics section). Inside the folder is a subfolder for each chair member where you can place your files.

ℹ️ There is no restriction on the exact path since you specify the path yourself in the topic document.

topics folder

The topics folder holds all documents with the description of the topics in Markdown. You can find a folder for each individual chair member where your files are stored.

⚠️ The leading underscore of the chair member folders is important! Without it the loading of the files will not work! Simply place the markdown files inside your folder an it will be automatically loaded. Information on how to structure the file is explained here.

Structure of topic files

ℹ️ The name of the file can be chosen arbitrarily.

An example of a topic file with all optional configurations can be seen here:

---
lang: de/en
img_src: <path-to-img>
additional_info: <path-to-file>/<link>
title: <topic-title>
tags: ["sb", "sm", "fm", "pm", "ba", "ma"]
date: <YYYY-MM-DD>
---

<Topic description>

The following table shows an explanation for each part of the file:

Name Possible Values Description optional
lang [de, en] Specifies whether the topic will be displayed on the german or english website (only one of the two can be set) no
img_src Path to the image file, beginning at /assets (e.g. /assets/trommer/my_awesome_topic.png) yes
additional_info or Path to an additional file inside the /assets folder or a link yes
title Title of your topic no
tags ["sb", "sm", "fm", "pm", "ba", "ma"] Tags of your topic, multiple can be selected (see here) yes
data Date where the topic as been posted (in the format Year-Month-Day no

Topic tags

Tag Description
sb Seminar Bachelor
sm Seminar Master
fm Research Module (Forschungsmodul)
pm Project Module (Projektmodul)
ba Bachelor Thesis
ma Master Thesis
Clone this wiki locally