This repository is a fork of NERSC Documentation at docs.nersc.gov.
This repository contains LIneA documentation written in Markdown which is converted to html/css/js with the mkdocs static site generator. The theme is mkdocs-material with LIneA customizations such as the colors injected via selective overloading of templates and CSS. The documentation pages are found in the top-level folder docs.
To report a problem with our documentation please create an issue and someone will work on your task. Before you create a ticket, please check if there is an existing issue for the same problem to avoid duplicate issues.
If you need any further assistance send an email to [email protected].
1. Clone the repo
git clone https://github.com/linea-it/docs/
2. Create the python virtual env and intall all packages
apt-get install python-pip python3.10-venv
python3 -m venv mkdocs
source mkdocs/bin/activate
pip install -r docs/requirements.txt
To run a local server using mkdocs:
cd docs
source mkdocs/bin/activate # if not loaded
mkdocs serve
This repository is licensed under the BSD 3-Clause. For more details, see LICENSE.