Welcome to the source files repository for my LPIC MkDocs documentation project, utilizing the Material for MkDocs theme. This project is designed to create clean, responsive, and professional documentation. Click here to access the LPIC resource site.
- MkDocs: A fast and straightforward static site generator tailored for building project documentation.
- Material for MkDocs: A modern theme based on Google's Material Design principles, offering a sleek and intuitive user experience.
You can view the live version of this documentation at:
https://github.com/micheal-ndoh/MK_DOCS
There are two ways to run the project locally and preview the documentation:
git clone https://github.com/micheal-ndoh/MK_DOCS
cd MK_DOCSBefore installing MkDocs, ensure Python and pip are installed:
sudo apt-get update
sudo apt-get install python3-pipIf you encounter the externally-managed-environment error, create and activate a virtual environment:
python3 -m venv myenv
source myenv/bin/activateInstall MkDocs and the Material theme:
pip install mkdocs
pip install mkdocs-materialmkdocs serveOpen your browser and navigate to http://127.0.0.1:8000 to view the documentation locally.
Pull the MkDocs Docker image from GitHub Packages:
docker pull ghcr.io/micheal-ndoh/mk_docs:latestdocker run -itd -p 8080:80 ghcr.io/micheal-ndoh/mk_docsOpen your browser and navigate to <your-container-ip>:8080 (e.g., 10.38.229.171:8080).
Generate static files for deployment:
mkdocs buildThe output will be stored in the site/ directory.
The project is configured to automatically deploy via GitHub Actions when changes are pushed to the main branch.
To manually deploy:
mkdocs gh-deployThis project is licensed under the MIT License. For more details, see the LICENSE file.