{"id":13573408,"url":"https://github.com/oprypin/mkdocs-gen-files","last_synced_at":"2025-04-08T09:09:09.012Z","repository":{"id":37038829,"uuid":"319447213","full_name":"oprypin/mkdocs-gen-files","owner":"oprypin","description":"MkDocs plugin to programmatically generate documentation pages during the build","archived":false,"fork":false,"pushed_at":"2025-02-15T16:34:14.000Z","size":113,"stargazers_count":120,"open_issues_count":11,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-01T08:30:24.251Z","etag":null,"topics":["mkdocs","mkdocs-plugin","mkdocstrings"],"latest_commit_sha":null,"homepage":"https://oprypin.github.io/mkdocs-gen-files","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oprypin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","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},"funding":{"github":"oprypin"}},"created_at":"2020-12-07T21:19:53.000Z","updated_at":"2025-03-08T05:44:39.000Z","dependencies_parsed_at":"2023-10-15T13:26:57.716Z","dependency_job_id":"6982d42f-8f54-4c97-b946-e6376b713666","html_url":"https://github.com/oprypin/mkdocs-gen-files","commit_stats":{"total_commits":86,"total_committers":5,"mean_commits":17.2,"dds":"0.046511627906976716","last_synced_commit":"85d56eb8ed6eccf1528ca158dbf97c8f0b6bb72e"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmkdocs-gen-files","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmkdocs-gen-files/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmkdocs-gen-files/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmkdocs-gen-files/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oprypin","download_url":"https://codeload.github.com/oprypin/mkdocs-gen-files/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247809964,"owners_count":20999816,"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":["mkdocs","mkdocs-plugin","mkdocstrings"],"created_at":"2024-08-01T15:00:34.416Z","updated_at":"2025-04-08T09:09:08.956Z","avatar_url":"https://github.com/oprypin.png","language":"Python","funding_links":["https://github.com/sponsors/oprypin"],"categories":["Python"],"sub_categories":[],"readme":"# mkdocs-gen-files\n\n**[Plugin][] for [MkDocs][] to programmatically generate documentation pages during the build**\n\n[![PyPI](https://img.shields.io/pypi/v/mkdocs-gen-files)](https://pypi.org/project/mkdocs-gen-files/)\n[![License](https://img.shields.io/github/license/oprypin/mkdocs-gen-files)](https://github.com/oprypin/mkdocs-gen-files/blob/master/LICENSE.md)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/oprypin/mkdocs-gen-files/ci.yml.svg)](https://github.com/oprypin/mkdocs-gen-files/actions?query=event%3Apush+branch%3Amaster)\n\n```shell\npip install mkdocs-gen-files\n```\n\n**Continue to the [documentation site][].**\n\n[mkdocs]: https://www.mkdocs.org/\n[plugin]: https://www.mkdocs.org/user-guide/plugins/\n[documentation site]: https://oprypin.github.io/mkdocs-gen-files\n\n## Usage\n\nActivate the plugin in **mkdocs.yml** (`scripts` is a required list of Python scripts to execute, always relative to **mkdocs.yml**):\n\n```yaml\nplugins:\n  - search\n  - gen-files:\n      scripts:\n        - gen_pages.py  # or any other name or path\n```\n\nThen create such a script **gen_pages.py** (this is relative to the root, *not* to the **docs** directory).\n\n```python\nimport mkdocs_gen_files\n\nwith mkdocs_gen_files.open(\"foo.md\", \"w\") as f:\n    print(\"Hello, world!\", file=f)\n```\n\nThis added a programmatically generated page to our site. That is, the document doesn't actually appear in our source files, it only *virtually* becomes part of the site to be built by MkDocs.\n\n**Continue to the [documentation site][].**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foprypin%2Fmkdocs-gen-files","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foprypin%2Fmkdocs-gen-files","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foprypin%2Fmkdocs-gen-files/lists"}