LMS-Community / lms-community.github.io

This is the web page for the Lyrion Music Server Community repository

lyrion.org

This is the web page for the LMS Community.

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

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

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. Build the Docker image with additional plugins (if using Docker):

docker build -t squidfunk/mkdocs-material .

4. Use mkdocs serve (or docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material if you're using the Docker image) to setup a live preview server from the local repository. The server will automatically rebuild the site upon saving.
5. Point your browser to localhost:8000.

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.