https://github.com/micheal-ndoh/mk_docs
A mkdocs documentation on LPIC 1 resources and hacks
https://github.com/micheal-ndoh/mk_docs
linux linux-kernel networking secuirty
Last synced: about 1 year ago
JSON representation
A mkdocs documentation on LPIC 1 resources and hacks
- Host: GitHub
- URL: https://github.com/micheal-ndoh/mk_docs
- Owner: micheal-ndoh
- Created: 2024-10-26T14:21:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-26T09:19:36.000Z (over 1 year ago)
- Last Synced: 2025-02-26T09:32:43.130Z (over 1 year ago)
- Topics: linux, linux-kernel, networking, secuirty
- Language: Python
- Homepage: https://www.lpi.org/our-certifications/lpic-1-overview/
- Size: 30.2 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# My MkDocs Project
This repository contains the source files for my MkDocs documentation project, using the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.
## 📚 Project Overview
- **MkDocs**: A fast, simple static site generator for building project documentation.
- **Material for MkDocs**: A professional, responsive theme built on Google's Material Design principles.
## 🚀 Live Documentation
You can view the live version of this documentation at:
[https://github.com/micheal-ndoh/MK_DOCS](https://github.com/micheal-ndoh/MK_DOCS)
## 🛠️ Local Setup
There are two ways to run the project locally and preview the documentation:
## Running it using mkdocs serve.
1. **Clone the repository**:
```bash
git clone https://github.com/micheal-ndoh/MK_DOCS
cd MK_DOCS
```
2. **Install MkDocs and dependencies**:
* Before installing mkdocs you need to ensure you have python and pip installed using
```bash
sudo apt-get update
sudo apt-get install python3-pip
```
* If you encounter a error: externally-managed-environment problem do this
Create a virtual environment using
```bash
python3 -m venv myenv
```
* then activate it with
```bash
source myenv/bin/activate
```
After activation, install mkdocs using pip3 install mkdocs
* Then install mkdocs and mkdocs materials
```bash
pip install mkdocs
pip3 install mkdocs-material
```
3. **Run the MkDocs development server**:
```bash
mkdocs serve
```
Open your browser and navigate to `http://127.0.0.1:8000` to view the documentation locally.
## 📦 Build and Deploy
- **Build the site**:
```bash
mkdocs build
```
This will generate static files in the `site/` directory.
- **Deploy to GitHub Pages**:
The project is set up to automatically deploy via GitHub Actions when changes are pushed to the `main` branch.
To manually deploy:
```bash
mkdocs gh-deploy
```
## 🐳 Running a docker container using my mkdocs docker image
1. Pull the image from my git hub packages
```bash
docker pull ghcr.io/micheal-ndoh/mk_docs:latest
```
2.After successfully pulling the image run a docker container with it.
```bash
docker run -itd -p 8080:80 ghcr.io/micheal-ndoh/mk_docs
```
3. Access the contents on your browser using the ip address of your container and the port you assigned when running the container :8080
```
e.g 10.38.229.171:8080
```
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.