lyrion.org

This is the web page for the LMS Community.

The site is based on mkdocs-material (https://squidfunk.github.io/mkdocs-material/).

Setup a local development environment

To get a local development environment up you can do one of the following:

Use docker

1. Clone this repository (or fork this repository).
2. Build the Docker image with additional plugins : docker build -t mkdocs-material-with-plugins .
3. Run docker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-material-with-plugins to setup a live preview server from the local repository. The server will automatically rebuild the site upon saving.
4. Point your browser to localhost:8000.

Install mkdocs-material

1. Follow the installation instructions on https://squidfunk.github.io/mkdocs-material/getting-started/ to make sure that mkdocs-material is installed on your system.
2. Clone this repository (or fork this repository).
3. Use mkdocs serve. The server will automatically rebuild the site upon saving.
4. Point your browser to localhost:8000.

Edit the pages

Adding a page is very simple, just add the appropriate .md page under the docs folder.

If you want to add the page to the navigation you can expand the nav structure in the mkdocs.yml.

Please see https://squidfunk.github.io/mkdocs-material/reference/ for more information about the framework.