| Name | mkdocs-gen-files JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | None |
| Summary | MkDocs plugin to programmatically generate documentation pages during the build |
| upload_time | 2023-04-27 19:48:04 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
mkdocs
mkdocs-plugin
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mkdocs-gen-files
**[Plugin][] for [MkDocs][] to programmatically generate documentation pages during the build**
[](https://pypi.org/project/mkdocs-gen-files/)
[](https://github.com/oprypin/mkdocs-gen-files/blob/master/LICENSE.md)
[](https://github.com/oprypin/mkdocs-gen-files/actions?query=event%3Apush+branch%3Amaster)
```shell
pip install mkdocs-gen-files
```
**Continue to the [documentation site][].**
[mkdocs]: https://www.mkdocs.org/
[plugin]: https://www.mkdocs.org/user-guide/plugins/
[documentation site]: https://oprypin.github.io/mkdocs-gen-files
## Usage
Activate the plugin in **mkdocs.yml** (`scripts` is a required list of Python scripts to execute, always relative to **mkdocs.yml**):
```yaml
plugins:
- search
- gen-files:
scripts:
- gen_pages.py # or any other name or path
```
Then create such a script **gen_pages.py** (this is relative to the root, *not* to the **docs** directory).
```python
import mkdocs_gen_files
with mkdocs_gen_files.open("foo.md", "w") as f:
print("Hello, world!", file=f)
```
This 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.
**Continue to the [documentation site][].**
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-gen-files",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "mkdocs,mkdocs-plugin",
"author": null,
"author_email": "Oleh Prypin <oleh@pryp.in>",
"download_url": "https://files.pythonhosted.org/packages/48/85/2d634462fd59136197d3126ca431ffb666f412e3db38fd5ce3a60566303e/mkdocs_gen_files-0.5.0.tar.gz",
"platform": null,
"description": "# mkdocs-gen-files\n\n**[Plugin][] for [MkDocs][] to programmatically generate documentation pages during the build**\n\n[](https://pypi.org/project/mkdocs-gen-files/)\n[](https://github.com/oprypin/mkdocs-gen-files/blob/master/LICENSE.md)\n[](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",
"bugtrack_url": null,
"license": null,
"summary": "MkDocs plugin to programmatically generate documentation pages during the build",
"version": "0.5.0",
"project_urls": {
"Documentation": "https://oprypin.github.io/mkdocs-gen-files/",
"History": "https://github.com/oprypin/mkdocs-gen-files/releases",
"Issues": "https://github.com/oprypin/mkdocs-gen-files/issues",
"Source": "https://github.com/oprypin/mkdocs-gen-files"
},
"split_keywords": [
"mkdocs",
"mkdocs-plugin"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e70f1e55b3fd490ad2cecb6e7b31892d27cb9fc4218ec1dab780440ba8579e74",
"md5": "003a829cd28ba3b01b81776e2aec45d8",
"sha256": "7ac060096f3f40bd19039e7277dd3050be9a453c8ac578645844d4d91d7978ea"
},
"downloads": -1,
"filename": "mkdocs_gen_files-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "003a829cd28ba3b01b81776e2aec45d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8380,
"upload_time": "2023-04-27T19:48:07",
"upload_time_iso_8601": "2023-04-27T19:48:07.059869Z",
"url": "https://files.pythonhosted.org/packages/e7/0f/1e55b3fd490ad2cecb6e7b31892d27cb9fc4218ec1dab780440ba8579e74/mkdocs_gen_files-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "48852d634462fd59136197d3126ca431ffb666f412e3db38fd5ce3a60566303e",
"md5": "cf3a80faf4598095178dbff58d77d57b",
"sha256": "4c7cf256b5d67062a788f6b1d035e157fc1a9498c2399be9af5257d4ff4d19bc"
},
"downloads": -1,
"filename": "mkdocs_gen_files-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "cf3a80faf4598095178dbff58d77d57b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7539,
"upload_time": "2023-04-27T19:48:04",
"upload_time_iso_8601": "2023-04-27T19:48:04.894174Z",
"url": "https://files.pythonhosted.org/packages/48/85/2d634462fd59136197d3126ca431ffb666f412e3db38fd5ce3a60566303e/mkdocs_gen_files-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-27 19:48:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oprypin",
"github_project": "mkdocs-gen-files",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-gen-files"
}
