{"id":18677973,"url":"https://github.com/vrerv/mkdocs-gen-nav-plugin","last_synced_at":"2025-04-12T02:39:16.852Z","repository":{"id":87573064,"uuid":"606368850","full_name":"vrerv/mkdocs-gen-nav-plugin","owner":"vrerv","description":"Mkdocs plugin for generating navigation by directory structure","archived":false,"fork":false,"pushed_at":"2024-09-30T02:43:50.000Z","size":30,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T02:39:12.535Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vrerv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-02-25T09:23:23.000Z","updated_at":"2025-03-18T17:06:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"8a7ed349-acba-4ea7-8ad7-f5bf8662787c","html_url":"https://github.com/vrerv/mkdocs-gen-nav-plugin","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrerv%2Fmkdocs-gen-nav-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrerv%2Fmkdocs-gen-nav-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrerv%2Fmkdocs-gen-nav-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrerv%2Fmkdocs-gen-nav-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vrerv","download_url":"https://codeload.github.com/vrerv/mkdocs-gen-nav-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248507284,"owners_count":21115567,"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":"2024-11-07T09:35:36.436Z","updated_at":"2025-04-12T02:39:16.833Z","avatar_url":"https://github.com/vrerv.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs Gen Nav Plugin\n\nThis plugin generates the `config['nav']` automatically for your MkDocs documentation site by finding all markdown files from the global `config['docs_dir']`.\n\n## Rules\n\nThe following rules are used to generate the navigation:\n\n* The file or directory names are used as the navigation title.\n* If a path name starts with two digits and '_' characters, it is ignored in the title. This means that it is only used to sort the navigation list.\n* If a path name starts with '_', it will be ignored. This means that the links to that markdown file should be a part of some other document manually.\n* The file named \"index.md\" in the docs root dir will be ignored. (It will be used as Home page)\n\n## Configuration\n\nAdd following lines to your `mkdocs.yml` configuration file:\n\n```\nplugins:\n  - gen_nav:\n      enabled: true\n```\n\n## Example\n\nyou can find example in [examples](./examples) directory\n\n## Install\n\n`pip install mkdocs-gen-nav-plugin`\n\n## Development\n\n[Development Guide](./docs/development.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvrerv%2Fmkdocs-gen-nav-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvrerv%2Fmkdocs-gen-nav-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvrerv%2Fmkdocs-gen-nav-plugin/lists"}