{"id":28994018,"url":"https://github.com/beekeeper-studio/mkdocs-ini-includer","last_synced_at":"2025-06-25T03:09:41.657Z","repository":{"id":300255572,"uuid":"1005618619","full_name":"beekeeper-studio/mkdocs-ini-includer","owner":"beekeeper-studio","description":"mkdocs plugin for including ini files in markdown","archived":false,"fork":false,"pushed_at":"2025-06-20T17:31:26.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-20T17:46:04.781Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/beekeeper-studio.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,"zenodo":null}},"created_at":"2025-06-20T14:17:47.000Z","updated_at":"2025-06-20T17:31:19.000Z","dependencies_parsed_at":"2025-06-20T17:46:09.902Z","dependency_job_id":"f0a4b151-7c39-4bb8-9838-77073f9cefc3","html_url":"https://github.com/beekeeper-studio/mkdocs-ini-includer","commit_stats":null,"previous_names":["beekeeper-studio/mkdocs-ini-includer"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/beekeeper-studio/mkdocs-ini-includer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beekeeper-studio%2Fmkdocs-ini-includer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beekeeper-studio%2Fmkdocs-ini-includer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beekeeper-studio%2Fmkdocs-ini-includer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beekeeper-studio%2Fmkdocs-ini-includer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beekeeper-studio","download_url":"https://codeload.github.com/beekeeper-studio/mkdocs-ini-includer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beekeeper-studio%2Fmkdocs-ini-includer/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261795345,"owners_count":23210621,"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":[],"created_at":"2025-06-25T03:09:40.661Z","updated_at":"2025-06-25T03:09:41.634Z","avatar_url":"https://github.com/beekeeper-studio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs INI Includer\n\nThis is a MkDocs plugin that allows a MkDocs site to include all or part of an INI file inside the docs at build time.\n\n## Why?\n- Documenting the configuration system of an app without having to copy/paste config sections\n- Showing the configuration for a specific feature\n\n## Features\n- ✅ Include whole INI files\n- ✅ Include specific sections (e.g., `[section.name]` and all sub-data)\n- ✅ Preserve comments (useful docs for users)\n- ✅ Support array keys like `key1[] = abc, key1[] = def`\n- ✅ Simple embedding without complex parsing\n\n## Installation\n\n```bash\npip install mkdocs-ini-includer\n```\n\n## Configuration\n\nAdd the plugin to your `mkdocs.yml`:\n\n```yaml\nplugins:\n  - ini-includer:\n      base_path: \"path/to/your/ini/files\"  # Optional: base path for INI files\n      config_file: \"app.ini\"              # Optional: default INI file\n```\n\n## Usage\n\n### Include Entire INI File\n\n```markdown\n{% ini-include %}\n```\n\nOr specify a specific file:\n\n```markdown\n{% ini-include file=\"config/app.ini\" %}\n```\n\n### Include Specific Section\n\n```markdown\n{% ini-include section=\"database\" %}\n```\n\n### Examples\n\nGiven an INI file `config/app.ini`:\n\n```ini\n# Application configuration\n[app]\nname = MyApp\nversion = 1.0.0\n\n# Database settings\n[database]\nhost = localhost\nport = 5432\n# Connection pool settings\npool_size = 10\n\n[database.ssl]\nenabled = true\ncert_path = /path/to/cert\n```\n\n**Include entire file:**\n```markdown\n{% ini-include %}\n```\n\n**Include only database section:**\n```markdown\n{% ini-include section=\"database\" %}\n```\n\nThis will include the `[database]` section and all its subsections like `[database.ssl]`.\n\n## Development \u0026 Live Reload\n\nThe plugin supports live reload during development. When using `mkdocs serve`, changes to INI files are automatically detected and trigger page rebuilds, allowing you to see updates immediately without restarting the development server.\n\n## Notes\n- File paths are relative to your `docs_dir` unless `base_path` is configured\n- Comments and formatting are preserved\n- Array keys (like `key[]=value`) are supported\n- Error handling displays helpful messages in the generated docs\n- Live reload works with `mkdocs serve` for real-time INI file updates\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeekeeper-studio%2Fmkdocs-ini-includer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeekeeper-studio%2Fmkdocs-ini-includer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeekeeper-studio%2Fmkdocs-ini-includer/lists"}