This repository contains the customer documentation for GEC.
Hint: A quickstart devcontainer is down below.
To be able to build and run this project, Ruby 2.4 or higher is required. In addition, RubyGems, GCC and Make must be installed. See Jekyll Installation for further details.
One those prerequisites are set up, install all dependencies by running:
bundle install
Now, the following commands are available:
Command | Description |
---|---|
jekyll serve |
Starts a development build |
jekyll build |
Creates a production build |
Jekyll will put the build output in the
_site
folder, while also keeping a cache in.jekyll-cache
This project is structured the following way:
Gemfile
and pinned by Gemfile.lock
_config.yml
_includes
folder for custom HTML templates_sass
folder for custom SASS stylingAll other folders containing markdown files and assets are the actual site content. Sites that exist in multiple languages can be placed
right next to each other (e.g. index.de.md
and index.en.md
), and assets (such as images) can be placed right next to the pages using
them.
The following tools & dependencies are being used:
Tool / dependencie | Description |
---|---|
Jekyll | Static Site Generator |
Just the Docs | Jekyll theme |
polyglot | Jekyll plugin for internationalization |
jekyll-postfiles | Jekyll plugin for using assets placed next to markdown files |