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 one of the following:
- Clone this repository (or fork this repository).
- Build the Docker image with additional plugins :
docker build -t LMS-Community/mkdocs-material-with-plugins . - Run
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs LMS-Community/mkdocs-material-with-pluginsto setup a live preview server from the local repository. The server will automatically rebuild the site upon saving. - Point your browser to localhost:8000.
- Follow the installation instructions on https://squidfunk.github.io/mkdocs-material/getting-started/ to make sure that mkdocs-material is installed on your system.
- Clone this repository (or fork this repository).
- Use
mkdocs serve. The server will automatically rebuild the site upon saving. - 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.