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 upAnd navigate to http://0.0.0.0:4000
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
permalinkvar to something likepermalink: /about/. - Also, it's a good idea to override the
titlevar as well - such astitle: About.
In case you want to add a blog section into the site:
- Create a
_postsfolder 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 yourpermalinkvar as you want - more info. - At
_config.yml, setatom_feed.hidetofalse.
- Here is the documentation about the deployment of the page on GitHub pages.
- Here is the documentation about how we work in the project during development.
- Here is the documentation about how to add more content to the website.
- Here is the documentation about how to use the Jekyll Includes.
- Here is the documentation about how a custom CSS can be used in the project.
- Here is the documentation about how you can update the gems in the gemfile.lock file.