Skip to content

Website

GRIGNOLA Nina edited this page Dec 6, 2023 · 4 revisions

Keycube Website

Who create this website ?

In what context ?

How ?

During how many time ?

How modify this website ?

Prerequisites

  1. Ensure Jekyll is installed. If not, follow this tutorial.

  2. Clone this repository.

  3. Ensure you have the necessary rights to modify the repository.

  4. Follow the instructions below.

All Pages working

All pages on the site have been automated. Easily add elements or information without diving into the code by following the information below.

About Page

To add a new contributors to the "About" page, follow these steps :

  1. Navigate to the _data folder.
  2. Open contributors.yml
  3. Create a new item using the following format
- pseudo: New Contributor Pseudo
  image: 'link to contributor image (optional)'
  url: 'link provided by the contributor'

If the image is internal, maintain consistency by placing it in the "assets/img/contributors" folder with the filename "pseudo.jpg".

Blog Page

To add a new article to the blog, follow these steps :

  1. Navigate to the _posts folder

  2. Create a new markdown file using the following template

    File Name: YYYY-MM-DD-postname.markdown

---
layout: post  # Never change this layout; it defines the visual style of the post
title: "Title of the post"
date: YYYY-MM-DD HH:MM:SS +0200
author: Author(s)' names
categories:  # For now, only 4 categories have been created, but you can add as many as you want
  - Games
  - Tools
  - Divers
  - Others
image: "link to the image for the post"
resume: "Some sentence to summarize the post"  # This part will be shown on the blog page before clicking on the post
featuredPost: true  # Set to true if you want to highlight this post as a featured post
---

Research Page

To add a new contributors to the "About" page, follow these steps :

  1. Navigate to the _data folder
  2. Open research.yml
  3. Create a new item using the following format
- date: Publication Date
  title: Research Title
  authors: Research Authors
  venue-journal: "Research Venue or Journal"
  url: 'link to read the research'

Software Page

  1. Navigate to the _data folder
  2. Open software.yml
  3. Create a new item using the following format
- title: Software Project Title
  description: Project Description
  key-features: Key Features
  link: 'link to the GitHub repository'
  image: 'link to an image corresponding to the project'

Hardware Page

To add hardware projects, navigate to the "_data" folder and open "hardware.yml".

In this file, you'll find a list of hardware projects. To add a new project, use the following format:

- title: Hardware Project Title
  description: Project Description
  key-features: Key Features
  git-link: 'link to the GitHub repository'
  image: 'link to an image corresponding to the project'

Flux RSS

Gem Minima

Clone this wiki locally