elemwave/website - Githubissues

Elemwave website

This site is hosted in Github Pages using Jekyll - a static site generator written in Ruby.

In order to test the site on local, just run:

docker-compose up

Docker documentation here

The site uses a remote theme called minimal-mistakes.

Please refer to their documentation in order to check how to customise the website and use layouts.

Useful documentation

As a side note, minimal-mistakes provides different skins.

You can easily change this at _config.yml, updating minimal_mistakes_skin var.

Custom bits of the code should be at /_includes.

In order to add a line at the top of the footer, create _includes/footer/custom.html.
In order to override theme's footer, create _includes/footer.html.
In order to override theme's header, create _includes/masthead.html.
In order to add new <head> content, create _includes/head/custom.html.

In case you want to add new pages with their own path:

Create a new markdown file at root - such as about.md.
Add any configuration at the top of the file following Jekyll and minimal-mistakes docs.
As an important note, you should override permalink var to something like permalink: /about/.
Also, it's a good idea to override the title var as well - such as title: About.

In case you want to add a blog section into the site:

Create a _posts folder at root.
Add your posts as 2021-11-17-welcome-to-jekyll.md.
Add any configuration at the top of the file following Jekyll and minimal-mistakes docs.
At _config.yml, set up your permalink var as you want - more info.
At _config.yml, set atom_feed.hide to false.

Here is the documentation about how you can update the gems in the gemfile.lock file.