https://github.com/gecio/gecio.github.io
https://github.com/gecio/gecio.github.io
documentation jekyll vscode
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gecio/gecio.github.io
- Owner: gecio
- Created: 2021-02-24T14:39:39.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T14:38:27.000Z (almost 2 years ago)
- Last Synced: 2024-08-29T16:19:27.871Z (almost 2 years ago)
- Topics: documentation, jekyll, vscode
- Language: SCSS
- Homepage: https://docs.gec.io
- Size: 103 MB
- Stars: 7
- Watchers: 5
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# GEC Customer Documentation
This repository contains the customer documentation for GEC.
## Setup
Hint: A quickstart devcontainer is [down below](#Using-the-(experimental)-docker-environment).
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](https://jekyllrb.com/docs/installation/)** for further details.
One those prerequisites are set up, install all dependencies by running:
```bash
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`
## Project
This project is structured the following way:
- Dependencies (e.g. theme, plugins) are defined in `Gemfile` and pinned by `Gemfile.lock`
- The Jekyll configuration (including configurations for theming and plugins) is defined in `_config.yml`
- Theme customizations (for the "Just the Docs" theme) are placed in
- the `_includes` folder for custom HTML templates
- the `_sass` folder for custom SASS styling
All 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.
## Tools & dependencies
The following tools & dependencies are being used:
| Tool / dependencie | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------ |
| **[Jekyll](https://jekyllrb.com/)** | Static Site Generator |
| **[Just the Docs](https://github.com/pmarsceill/just-the-docs)** | Jekyll theme |
| **[polyglot](https://github.com/untra/polyglot)** | Jekyll plugin for internationalization |
| **[jekyll-postfiles](https://github.com/nhoizey/jekyll-postfiles)** | Jekyll plugin for using assets placed next to markdown files |
## Using the (experimental) docker environment
### Requirements
- Visual Studio Code
- The [Remote Development Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)
- Docker, like [Docker Desktop](https://www.docker.com/products/docker-desktop)
### Procedure
- Clone this repository
- Open it in Visual Studio Code
- VSCode will prompt, if you want to run the integrated dev container, select yes
- Wait for the build to finish, it might take some minutes on the first run
- Have fun!
### Hints
- Your ssh agent and git configuration should automatically be available inside the dev container.
- You can change the devcontainer image to your preferences, by adding a [Dotfile-Repository](https://code.visualstudio.com/docs/remote/containers#_personalizing-with-dotfile-repositories)