/Documentation-Gobolinux

Documentation of the GoboLinux project

Primary LanguageCSSMIT LicenseMIT

GoboLinux Documentation

Here resides the official GoboLinux Documentation.

It has been build using Hugo Static Site Generator, based on the wonderful Hugo Relearn Theme.

Project Structure

You will find the documentation under contents/ in markdown format. The projects main stylesheet lays under static/css/.

The main configuration is stored in config.toml.

If you need more info consult the official Hugo and Hugo Relearn Theme docs.

How to run locally

  1. Install Hugo. If you are on GoboLinux simply run Compile Hugo.

  2. Clone this repository including submodules:

git clone --recurse-submodules https://github.com/gobolinux/Documentation.git

  1. Enter the project directory and type hugo serve

  2. Open http://localhost:1313/ (by default)

  3. That's it! Any project changes will be automatically reflected on your local server.

Note to Contributors

Contributions to the documentation (residing within content/) are licensed under CC BY-SA 3.0.

The project source code is licensed under the MIT License.

So feel free and even encouraged to submit your contributions! ❤️