https://github.com/oprypin/mkdocs-gen-files

MkDocs plugin to programmatically generate documentation pages during the build
https://github.com/oprypin/mkdocs-gen-files

mkdocs mkdocs-plugin mkdocstrings

Last synced: about 2 months ago
JSON representation

MkDocs plugin to programmatically generate documentation pages during the build

• Host: GitHub
• URL: https://github.com/oprypin/mkdocs-gen-files
• Owner: oprypin
• License: mit
• Created: 2020-12-07T21:19:53.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-14T13:43:03.000Z (2 months ago)
• Last Synced: 2024-07-18T21:50:19.820Z (2 months ago)
• Topics: mkdocs, mkdocs-plugin, mkdocstrings
• Language: Python
• Homepage: https://oprypin.github.io/mkdocs-gen-files
• Size: 99.6 KB
• Stars: 98
• Watchers: 3
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - oprypin/mkdocs-gen-files - MkDocs plugin to programmatically generate documentation pages during the build (Python)

README

        
# mkdocs-gen-files

**[Plugin][] for [MkDocs][] to programmatically generate documentation pages during the build**

[![PyPI](https://img.shields.io/pypi/v/mkdocs-gen-files)](https://pypi.org/project/mkdocs-gen-files/)

[![License](https://img.shields.io/github/license/oprypin/mkdocs-gen-files)](https://github.com/oprypin/mkdocs-gen-files/blob/master/LICENSE.md)

[![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)

```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][].**