COMOKIT-Website 📘

· ·
·

This repository holds the Jekyll sources of the COMOKIT website!

How the website works

There's 3 important place :

• / The landing page of the website (isn't not generated yet => Raw HTML page)
• /docs The generated documentation (use Jekyll x Just-The-Doc)
• /ressources Recommanded place to upload big/extra files (ODD PDF, etc)

I want to update the documentation

Please go to the /docs/docs/ sub-folder to edit/add page (written in MarkDown) ;)

> Click me <

The documentation part is using the Just-The-Doc framework. If you have some interrogation on how to edit the page, please refere to the official documentation

Technical part (Documentation part)

Local installation & Setup

First of all, make sure ruby is intalled on your computer.

1. Clone the repo git clone https://github.com/COMOKIT/COMOKIT-Website.git
2. Move in the folder cd COMOKIT-Website/docs
3. Install the JTD framework gem install just-the-docs
4. (Optional) Enable search bundle exec just-the-docs rake search:init
5. Install plugins: bundle install --full-index
6. Build your site: bundle exec jekyll serve
7. Connect to your running instance http://127.0.0.1:4000/docs/

Global configuration of the doc part

All the global configuration of the site can be found in the file _config.yml which is structured as follow :

Bugs and Issues

Have a bug or an issue with this template? Open a new issue here on GitHub!

Made with

• Pipeline

  • Jekyll
  • GitHub Actions
  • GitHub Pages

• Front-end

  • Raw HTML - Landing Page
  • Just-The-Doc - Jekyll framework

Copyright and License

The COMOKIT project is licensed under the GPL-3.0 License.