{"id":21637813,"url":"https://github.com/theoneoh1/web-docs","last_synced_at":"2026-05-06T13:38:40.457Z","repository":{"id":262078961,"uuid":"886160224","full_name":"TheOneOh1/web-docs","owner":"TheOneOh1","description":"A website to store all your Documentations in markdown","archived":false,"fork":false,"pushed_at":"2024-11-10T11:33:25.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-25T01:15:07.786Z","etag":null,"topics":["docker","documentation","documentation-website","markdown"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","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/TheOneOh1.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-11-10T11:14:02.000Z","updated_at":"2024-11-10T11:35:26.000Z","dependencies_parsed_at":"2024-11-10T12:31:29.649Z","dependency_job_id":null,"html_url":"https://github.com/TheOneOh1/web-docs","commit_stats":null,"previous_names":["theoneoh1/web-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheOneOh1%2Fweb-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheOneOh1%2Fweb-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheOneOh1%2Fweb-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheOneOh1%2Fweb-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheOneOh1","download_url":"https://codeload.github.com/TheOneOh1/web-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235524162,"owners_count":19003817,"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":["docker","documentation","documentation-website","markdown"],"created_at":"2024-11-25T04:07:01.834Z","updated_at":"2025-10-26T05:46:56.486Z","avatar_url":"https://github.com/TheOneOh1.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DevOps Documentation Site\n\nA minimalist, dark-themed documentation website for DevOps practices and tools, built with MkDocs Material theme.\n\n## Quick Start\n\n1. Install dependencies: \n\n```bash\npip install mkdocs mkdocs-material\n```\n\n2. Start the development server:\n\n```bash\nmkdocs serve\n```\n3. View the site at `http://127.0.0.1:8000`\n\n## Project Structure\n\n- `mkdocs.yml`: The configuration file for MkDocs.\n- `docs/`: Directory containing Markdown files for the documentation.\n- `docs.html`: Custom HTML template for the documentation page.\n\n```\n├── index.md # Homepage\n├── getting-started/ # Getting Started section\n│ └── index.md # Main getting started page\n├── deployment/ # Deployment section\n│ ├── index.md # Main deployment page\n│ └── ci-cd.md # CI/CD specific guide\n└── monitoring/ # Monitoring section\n└── index.md # Main monitoring page\nmkdocs.yml # MkDocs configuration\n```\n\n## Adding Content\n\n### New Pages\n\n1. Create a new `.md` file in the appropriate section folder under `docs/`\n2. Add front matter at the top of the file:\n\n```markdown\n---\ntitle: Your Page Title\ncategory: Section Name\n---\n```\n\n### New Sections\n\n1. Create a new folder under `docs/`\n2. Add an `index.md` file in the new folder\n3. Update `mkdocs.yml` if you need to customize the navigation\n\n## File Purposes\n\n- `mkdocs.yml`: Main configuration file. Edit to change:\n  - Site theme and appearance\n  - Navigation structure\n  - Plugins and extensions\n  - Search settings\n\n- `docs/index.md`: Homepage content and main navigation\n  - Update \"Quick Navigation\" section when adding new categories\n  - Maintain \"Latest Updates\" section\n\n- Section `index.md` files (e.g., `docs/deployment/index.md`):\n  - Main overview page for each section\n  - Contains section-specific navigation\n\n## Building for Production\n\n1. Build the static site:\n\n```bash\nmkdocs build\n```\n2. The built site will be in the `site/` directory\n\n## Theme Customization\n\n- Edit theme settings in `mkdocs.yml`\n- Current theme: Material Dark (Slate)\n- Primary color: Deep Purple\n- Accent color: Purple\n\n## Features\n\n- 🔍 Full-text search\n- 📱 Mobile responsive\n- 🌙 Dark theme\n- ✨ Syntax highlighting\n- 📝 Table of contents\n- 🔗 Auto-generated navigation\n\n\n## Docker Deployment\n\n1. Development Environment :\n\n```bash\ndocker compose up docs-dev\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheoneoh1%2Fweb-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheoneoh1%2Fweb-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheoneoh1%2Fweb-docs/lists"}