mkdocs-pages-json-plugin


Namemkdocs-pages-json-plugin JSON
Version 0.0.2 PyPI version JSON
download
home_pageNone
SummaryAn MkDocs plugin that generates a pages.json file with page metadata.
upload_time2025-08-13 18:01:23
maintainerNone
docs_urlNone
authorBradley Stannard
requires_python>=3.6
licenseMIT
keywords mkdocs python json plugin
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Pages json generator

A terrible plugin for mkdocs to generate a `pages.json` file for sites that have a `reviewdate` field on pages

Makes a json file like

```json
[
  {
    "title": "Aqua Page 1",
    "url": "http://127.0.0.1:8000/security/aqua/aqua-page-1/",
    "review_by": "2022-01-01"
  },
  {
    "title": "Aqua Page 2",
    "url": "http://127.0.0.1:8000/security/aqua/aqua-page-2/",
    "review_by": "2022-01-01"
  },
  {
    "title": "Aqua partnership notes",
    "url": "http://127.0.0.1:8000/security/aqua/partnership-info/",
    "review_by": "2022-01-01"
  }
]
```

## Install

```shell
pip3 install git+https://github.com/userbradley/mkdocs-pages-json-plugin.git
```

This is until I can figure out how to put this on PyPi or what ever

```yaml
plugins:
  - pages-json:
        output_file: 'api/pages.json'
```

## Using

You should now be able to go to your site, and the path you chose (for example `api/pages.json`) and see the file.

An example of this in action: https://documentation.breadnet.co.uk/api/pages.json

---

Built by Bradley, with love in the UK. Licensed under MIT so you can do what ever you want with this

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mkdocs-pages-json-plugin",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "mkdocs python json plugin",
    "author": "Bradley Stannard",
    "author_email": "opensource@breadnet.co.uk",
    "download_url": "https://files.pythonhosted.org/packages/87/3b/aac6aedeb92ca40c2faeda6ba749f1b69f2ede49f5f83f82e14f220d15cf/mkdocs-pages-json-plugin-0.0.2.tar.gz",
    "platform": null,
    "description": "# Pages json generator\n\nA terrible plugin for mkdocs to generate a `pages.json` file for sites that have a `reviewdate` field on pages\n\nMakes a json file like\n\n```json\n[\n  {\n    \"title\": \"Aqua Page 1\",\n    \"url\": \"http://127.0.0.1:8000/security/aqua/aqua-page-1/\",\n    \"review_by\": \"2022-01-01\"\n  },\n  {\n    \"title\": \"Aqua Page 2\",\n    \"url\": \"http://127.0.0.1:8000/security/aqua/aqua-page-2/\",\n    \"review_by\": \"2022-01-01\"\n  },\n  {\n    \"title\": \"Aqua partnership notes\",\n    \"url\": \"http://127.0.0.1:8000/security/aqua/partnership-info/\",\n    \"review_by\": \"2022-01-01\"\n  }\n]\n```\n\n## Install\n\n```shell\npip3 install git+https://github.com/userbradley/mkdocs-pages-json-plugin.git\n```\n\nThis is until I can figure out how to put this on PyPi or what ever\n\n```yaml\nplugins:\n  - pages-json:\n        output_file: 'api/pages.json'\n```\n\n## Using\n\nYou should now be able to go to your site, and the path you chose (for example `api/pages.json`) and see the file.\n\nAn example of this in action: https://documentation.breadnet.co.uk/api/pages.json\n\n---\n\nBuilt by Bradley, with love in the UK. Licensed under MIT so you can do what ever you want with this\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An MkDocs plugin that generates a pages.json file with page metadata.",
    "version": "0.0.2",
    "project_urls": null,
    "split_keywords": [
        "mkdocs",
        "python",
        "json",
        "plugin"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4cf8d82f8bc88accb8aab5bb2be31a2234c0a57b9404393fd9d8616d009375bb",
                "md5": "96c69a84c0e1ff1a2df4786ad1a62e76",
                "sha256": "03e3fff210540c3becb068174997289b985a403df597520e1729ed3a618bdf41"
            },
            "downloads": -1,
            "filename": "mkdocs_pages_json_plugin-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "96c69a84c0e1ff1a2df4786ad1a62e76",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 3702,
            "upload_time": "2025-08-13T18:01:22",
            "upload_time_iso_8601": "2025-08-13T18:01:22.748256Z",
            "url": "https://files.pythonhosted.org/packages/4c/f8/d82f8bc88accb8aab5bb2be31a2234c0a57b9404393fd9d8616d009375bb/mkdocs_pages_json_plugin-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "873baac6aedeb92ca40c2faeda6ba749f1b69f2ede49f5f83f82e14f220d15cf",
                "md5": "d1f54c91ecb40bd64d19f0066ab788c8",
                "sha256": "0c20951933806ad22580fceabd67803536d74524c0f775ad65167c8077e6b1d3"
            },
            "downloads": -1,
            "filename": "mkdocs-pages-json-plugin-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "d1f54c91ecb40bd64d19f0066ab788c8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 3110,
            "upload_time": "2025-08-13T18:01:23",
            "upload_time_iso_8601": "2025-08-13T18:01:23.702042Z",
            "url": "https://files.pythonhosted.org/packages/87/3b/aac6aedeb92ca40c2faeda6ba749f1b69f2ede49f5f83f82e14f220d15cf/mkdocs-pages-json-plugin-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-13 18:01:23",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mkdocs-pages-json-plugin"
}
Bradley Stannard
Elapsed time: 0.89616s