{"id":25750156,"url":"https://github.com/micheal-ndoh/mk_docs","last_synced_at":"2025-05-12T16:30:10.009Z","repository":{"id":268555053,"uuid":"878938091","full_name":"micheal-ndoh/MK_DOCS","owner":"micheal-ndoh","description":"A mkdocs documentation on LPIC 1 resources and hacks","archived":false,"fork":false,"pushed_at":"2025-02-26T09:19:36.000Z","size":31648,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-26T09:32:43.130Z","etag":null,"topics":["linux","linux-kernel","networking","secuirty"],"latest_commit_sha":null,"homepage":"https://www.lpi.org/our-certifications/lpic-1-overview/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/micheal-ndoh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-26T14:21:37.000Z","updated_at":"2025-02-26T09:19:39.000Z","dependencies_parsed_at":"2024-12-17T14:18:55.587Z","dependency_job_id":"2b2b736d-f0bd-4eab-bde2-c11823654a3e","html_url":"https://github.com/micheal-ndoh/MK_DOCS","commit_stats":null,"previous_names":["micheal-ndoh/mk_docs"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheal-ndoh%2FMK_DOCS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheal-ndoh%2FMK_DOCS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheal-ndoh%2FMK_DOCS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micheal-ndoh%2FMK_DOCS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/micheal-ndoh","download_url":"https://codeload.github.com/micheal-ndoh/MK_DOCS/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240858607,"owners_count":19869001,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["linux","linux-kernel","networking","secuirty"],"created_at":"2025-02-26T13:15:45.826Z","updated_at":"2025-02-26T13:15:46.625Z","avatar_url":"https://github.com/micheal-ndoh.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# My MkDocs Project\n\nThis repository contains the source files for my MkDocs documentation project, using the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.\n\n\n## 📚 Project Overview\n\n- **MkDocs**: A fast, simple static site generator for building project documentation.\n- **Material for MkDocs**: A professional, responsive theme built on Google's Material Design principles.\n\n## 🚀 Live Documentation\n\nYou can view the live version of this documentation at:\n[https://github.com/micheal-ndoh/MK_DOCS](https://github.com/micheal-ndoh/MK_DOCS)\n\n## 🛠️ Local Setup\n\nThere are two ways to run the project locally and preview the documentation:\n\n## Running it using mkdocs serve. \n\n1. **Clone the repository**:\n    ```bash\n    git clone https://github.com/micheal-ndoh/MK_DOCS\n    cd MK_DOCS\n    ```\n\n2. **Install MkDocs and dependencies**:\n* Before installing mkdocs you need to ensure you have python and pip installed using\n  ```bash\n  sudo apt-get update\n  sudo apt-get install python3-pip\n  ```\n* If you encounter a error: externally-managed-environment problem do this\n  Create a virtual environment using\n  ```bash\n  python3 -m venv myenv\n  ```\n* then activate it with\n  ```bash\n  source myenv/bin/activate\n  ```\n After activation,  install mkdocs using pip3 install mkdocs\n\n* Then install mkdocs and mkdocs materials\n  \n    ```bash\n    pip install mkdocs\n    pip3 install mkdocs-material\n    ```\n\n3. **Run the MkDocs development server**:\n    ```bash\n    mkdocs serve\n    ```\n\n    Open your browser and navigate to `http://127.0.0.1:8000` to view the documentation locally.\n\n## 📦 Build and Deploy\n\n- **Build the site**:\n    ```bash\n    mkdocs build\n    ```\n\n    This will generate static files in the `site/` directory.\n\n- **Deploy to GitHub Pages**:\n    The project is set up to automatically deploy via GitHub Actions when changes are pushed to the `main` branch.\n\n    To manually deploy:\n    ```bash\n    mkdocs gh-deploy\n    ```\n## 🐳 Running a docker container using my mkdocs docker image\n \n 1. Pull the image from my git hub packages\n```bash\ndocker pull ghcr.io/micheal-ndoh/mk_docs:latest\n```\n2.After successfully pulling the image run a docker container with it.\n```bash\ndocker run -itd -p 8080:80 ghcr.io/micheal-ndoh/mk_docs\n```\n3. Access the contents on your browser using the ip address of your container and the port you assigned when running the container   \u003cyour IP\u003e:8080\n```\ne.g 10.38.229.171:8080\n```\n\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicheal-ndoh%2Fmk_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicheal-ndoh%2Fmk_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicheal-ndoh%2Fmk_docs/lists"}