LionsOS documentation

This repository holds the source for the documentation website for the Lions Operating System.

If you find any issues with the documentation please file an issue or create a pull request.

The website is built using the Hugo static site generator with the Hugo Book theme.

Dependencies

To install Hugo follow the instructions below for your environment.

On Ubuntu/Debian:

sudo apt install hugo

On macOS with Homebrew:

brew install hugo

Developing

Each page is written using Markdown and can be found in content/docs/.

If you are not familiar with Hugo Book, please see the documentation and example website to learn more.

If you are developing the documentation and want to preview your changes, run:

./server.sh

You should see a message such as Web Server is available at http://localhost:1313/. Open the link in your browser to view the documentation, the page will automatically reload on any changes.

Offline version

If you need store an offline version of the documentation, you should be able to do:

git clone https://github.com/au-ts/lionsos_docs
cd lionsos_docs
git submodule update --init
hugo --gc --minify

All the generated files will be in public/.

Design files

All diagrams are in SVG format and made in a tool called Figma.

The link to the design file is here.