Currently hosted at https://corolab.github.io
- Please check if you can find the answer through the corresponding file and/or folder in-source documentation, as well as in the Issues section (both Open and Closed issues).
- If your doubt or comment is not a duplicate, please post a detailed New issue.
- How to serve on localhost
- How to upload changes to GitHub
- How to add/modify website metadata and social media links
- How to modify the About section
- How to add/modify a Member
- How to add/modify a Robot
- How to add/modify a Project
- How to add a new section
It is useful to serve on localhost to modify the website and see changes locally.
- From the root of the project, run the following command (which is universal for all jekyll-based projects):
bundle exec jekyll serve- You can now browse the site at the default location: http://127.0.0.1:4000
This project is managed as any project on GitHub. You may use Git or even the GitHub web interface, both on which you can find many tutorials online. The following points are specific to the GitHub Pages mechanism used, and its current settings:
-
Please do not upload the
_site/folder, nor theGemfile.lockfile. They are auto-generated locally, and the same should happen on the GitHub Pages servers. -
It is safe to
git pushto any upstream branch, just remember that what is onmasteris what will be actually rendered as the website.
-
The first line of this
README.mdfile, which is the file you are reading, becomes the.html<head><title>(what is seen on the browser's tab description). -
The /_config.yml contains metadata that is important for SEO, basic project settings, as well as links to social media. You can add new links on it for free, and they will be rendered nicely.
-
More colors and also behaviours have also set up in /_includes/css/agency.css.
This section is in fact in plain .html, the /_includes/about.html file, which you can edit manually. If images are ever added, please create an img/about/ folder.
This section is slightly more complex. To keep everything tidy, please place all used images in the /img/members/ folder (note: images must currently be 720x720).
-
We auto-magically parse the different type of
Membersfrom the /_members/ folder. Insert or modify.markdownfiles as described in the /_members/README.md file. Advanced: the parsing is achieved via the jekyll collections mechanism, implemented here and here. -
The rest of members may be edited manually in plain
.html, the /_includes/members.html file.
This section is in fact in plain .html, the /_includes/robots.html file, which you can edit manually. To keep everything tidy, please place all used images in the /img/robots/ folder (note: images must currently be 720x720).
This section is in fact in plain .html, the /_includes/projects.html file, which you can edit manually. To keep everything tidy, please place all used images in the /img/projects/ folder (note: images must currently be 720x720).
Here is how to add a new (static) section, as was done for about, robots, or projects:
- Add some template plain
.htmlcode at /_includes. - Include it from within _layouts/default.html.
- Add a bullet point with a link to it from within /_includes/header.html.
- In some cases, you may also create a folder inside the /img/ folder.
- In some cases, you may also add some
.csscode in /_includes/css/agency.css. - Add a new section in this page in how to modify it and its contents.