neoteroi-mkdocs


Nameneoteroi-mkdocs JSON
Version 1.1.0 PyPI version JSON
download
home_pageNone
SummaryPlugins for MkDocs and Python Markdown
upload_time2024-08-10 14:47:16
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseNone
keywords markdown mkdocs openapi swagger documentation extensions plugins
VCS
bugtrack_url
requirements pytest pytest-cov essentials-openapi mkdocs flake8 black isort flask
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![Build](https://github.com/Neoteroi/mkdocs-plugins/workflows/Build/badge.svg)
[![pypi](https://img.shields.io/pypi/v/neoteroi-mkdocs.svg)](https://pypi.python.org/pypi/neoteroi-mkdocs)
[![versions](https://img.shields.io/pypi/pyversions/neoteroi-mkdocs.svg)](https://github.com/neoteroi/mkdocs-plugins)
[![license](https://img.shields.io/github/license/neoteroi/mkdocs-plugins.svg)](https://github.com/neoteroi/mkdocs-plugins/blob/main/LICENSE)
[![codecov](https://codecov.io/gh/Neoteroi/mkdocs-plugins/branch/main/graph/badge.svg)](https://codecov.io/gh/Neoteroi/mkdocs-plugins)
[![documentation](https://img.shields.io/badge/📖-docs-purple)](https://www.neoteroi.dev/mkdocs-plugins/)


# Plugins for MkDocs and Python Markdown

```bash
pip install neoteroi-mkdocs
```

This package includes the following plugins and extensions:

| Name                                                              | Description                                                               |
| :---------------------------------------------------------------- | :------------------------------------------------------------------------ |
| [`mkdocsoad`](https://www.neoteroi.dev/mkdocs-plugins/web/oad/)   | Generates documentation from OpenAPI specification files.                 |
| [`cards`](https://www.neoteroi.dev/mkdocs-plugins/cards/)         | Component to display cards.                                               |
| [`timeline`](https://www.neoteroi.dev/mkdocs-plugins/timeline/)   | Component to display chronological information with style.                |
| [`gantt`](https://www.neoteroi.dev/mkdocs-plugins/gantt/)         | Component to display Gantt diagrams.                                      |
| [`spantable`](https://www.neoteroi.dev/mkdocs-plugins/spantable/) | Tables supporting colspan and rowspan.                                    |
| [`contribs`](https://www.neoteroi.dev/mkdocs-plugins/contribs/)   | MkDocs plugin to display last commit time and contributors for each file. |

## Documentation
Refer to the [documentation site](https://www.neoteroi.dev/mkdocs-plugins/). :rocket:

---

## Preview

### Cards extension

![Cards](https://gist.githubusercontent.com/RobertoPrevato/38a0598b515a2f7257c614938843b99b/raw/24a200029c70c3cda2d31db5b4ceda9692a98854/cards.png)

<em>Greek Mythology icons made by <a href="https://www.flaticon.com/authors/maxicons" title="max.icons">max.icons</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></em>

---

### Gantt extension

![Gantt diagram](https://gist.githubusercontent.com/RobertoPrevato/38a0598b515a2f7257c614938843b99b/raw/eaf8116b887c72f024b51c94206064b4dfd46052/gantt.png)

### Timeline extension

![Timeline](https://gist.githubusercontent.com/RobertoPrevato/38a0598b515a2f7257c614938843b99b/raw/90c4a7bdeddc2f9ebdf205b02d8153c3de24f0f4/timeline.png)


### OpenAPI Documentation extension

![OAD 1](https://gist.githubusercontent.com/RobertoPrevato/38a0598b515a2f7257c614938843b99b/raw/eaf8116b887c72f024b51c94206064b4dfd46052/oad-example-1.png)

![OAD 2](https://gist.githubusercontent.com/RobertoPrevato/38a0598b515a2f7257c614938843b99b/raw/eaf8116b887c72f024b51c94206064b4dfd46052/oad-example-2.png)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "neoteroi-mkdocs",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "Markdown, MkDocs, OpenAPI, Swagger, documentation, extensions, plugins",
    "author": null,
    "author_email": "Roberto Prevato <roberto.prevato@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ea/b2/0dfb7d83c71f33be1ad5309ab80ca255e5629f272da7e5c2c5a314d89e86/neoteroi_mkdocs-1.1.0.tar.gz",
    "platform": null,
    "description": "![Build](https://github.com/Neoteroi/mkdocs-plugins/workflows/Build/badge.svg)\n[![pypi](https://img.shields.io/pypi/v/neoteroi-mkdocs.svg)](https://pypi.python.org/pypi/neoteroi-mkdocs)\n[![versions](https://img.shields.io/pypi/pyversions/neoteroi-mkdocs.svg)](https://github.com/neoteroi/mkdocs-plugins)\n[![license](https://img.shields.io/github/license/neoteroi/mkdocs-plugins.svg)](https://github.com/neoteroi/mkdocs-plugins/blob/main/LICENSE)\n[![codecov](https://codecov.io/gh/Neoteroi/mkdocs-plugins/branch/main/graph/badge.svg)](https://codecov.io/gh/Neoteroi/mkdocs-plugins)\n[![documentation](https://img.shields.io/badge/\ud83d\udcd6-docs-purple)](https://www.neoteroi.dev/mkdocs-plugins/)\n\n\n# Plugins for MkDocs and Python Markdown\n\n```bash\npip install neoteroi-mkdocs\n```\n\nThis package includes the following plugins and extensions:\n\n| Name                                                              | Description                                                               |\n| :---------------------------------------------------------------- | :------------------------------------------------------------------------ |\n| [`mkdocsoad`](https://www.neoteroi.dev/mkdocs-plugins/web/oad/)   | Generates documentation from OpenAPI specification files.                 |\n| [`cards`](https://www.neoteroi.dev/mkdocs-plugins/cards/)         | Component to display cards.                                               |\n| [`timeline`](https://www.neoteroi.dev/mkdocs-plugins/timeline/)   | Component to display chronological information with style.                |\n| [`gantt`](https://www.neoteroi.dev/mkdocs-plugins/gantt/)         | Component to display Gantt diagrams.                                      |\n| [`spantable`](https://www.neoteroi.dev/mkdocs-plugins/spantable/) | Tables supporting colspan and rowspan.                                    |\n| [`contribs`](https://www.neoteroi.dev/mkdocs-plugins/contribs/)   | MkDocs plugin to display last commit time and contributors for each file. |\n\n## Documentation\nRefer to the [documentation site](https://www.neoteroi.dev/mkdocs-plugins/). :rocket:\n\n---\n\n## Preview\n\n### Cards extension\n\n![Cards](https://gist.githubusercontent.com/RobertoPrevato/38a0598b515a2f7257c614938843b99b/raw/24a200029c70c3cda2d31db5b4ceda9692a98854/cards.png)\n\n<em>Greek Mythology icons made by <a href=\"https://www.flaticon.com/authors/maxicons\" title=\"max.icons\">max.icons</a> from <a href=\"https://www.flaticon.com/\" title=\"Flaticon\">www.flaticon.com</a></em>\n\n---\n\n### Gantt extension\n\n![Gantt diagram](https://gist.githubusercontent.com/RobertoPrevato/38a0598b515a2f7257c614938843b99b/raw/eaf8116b887c72f024b51c94206064b4dfd46052/gantt.png)\n\n### Timeline extension\n\n![Timeline](https://gist.githubusercontent.com/RobertoPrevato/38a0598b515a2f7257c614938843b99b/raw/90c4a7bdeddc2f9ebdf205b02d8153c3de24f0f4/timeline.png)\n\n\n### OpenAPI Documentation extension\n\n![OAD 1](https://gist.githubusercontent.com/RobertoPrevato/38a0598b515a2f7257c614938843b99b/raw/eaf8116b887c72f024b51c94206064b4dfd46052/oad-example-1.png)\n\n![OAD 2](https://gist.githubusercontent.com/RobertoPrevato/38a0598b515a2f7257c614938843b99b/raw/eaf8116b887c72f024b51c94206064b4dfd46052/oad-example-2.png)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Plugins for MkDocs and Python Markdown",
    "version": "1.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/Neoteroi/mkdocs-plugins/issues",
        "Homepage": "https://github.com/Neoteroi/mkdocs-plugins"
    },
    "split_keywords": [
        "markdown",
        " mkdocs",
        " openapi",
        " swagger",
        " documentation",
        " extensions",
        " plugins"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eadd7f0cc18dfbd4cf8f303003c5b94eac63442190281219f6ac87800e7e015f",
                "md5": "fe0eed1648fa90239011fcd1de4f56d8",
                "sha256": "9c59aebf83ca09d1d486bf8c0351e6ddfa912f09413d153ecabc5cd268a3155a"
            },
            "downloads": -1,
            "filename": "neoteroi_mkdocs-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fe0eed1648fa90239011fcd1de4f56d8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 38228,
            "upload_time": "2024-08-10T14:47:15",
            "upload_time_iso_8601": "2024-08-10T14:47:15.132437Z",
            "url": "https://files.pythonhosted.org/packages/ea/dd/7f0cc18dfbd4cf8f303003c5b94eac63442190281219f6ac87800e7e015f/neoteroi_mkdocs-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eab20dfb7d83c71f33be1ad5309ab80ca255e5629f272da7e5c2c5a314d89e86",
                "md5": "fd0575fcc3d5af0569ed20f6acbf236c",
                "sha256": "609aae655e781c7aec517ab14759c34ce896b8132d1df4b9c2e504779c2e48ef"
            },
            "downloads": -1,
            "filename": "neoteroi_mkdocs-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fd0575fcc3d5af0569ed20f6acbf236c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 25009,
            "upload_time": "2024-08-10T14:47:16",
            "upload_time_iso_8601": "2024-08-10T14:47:16.809658Z",
            "url": "https://files.pythonhosted.org/packages/ea/b2/0dfb7d83c71f33be1ad5309ab80ca255e5629f272da7e5c2c5a314d89e86/neoteroi_mkdocs-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-10 14:47:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Neoteroi",
    "github_project": "mkdocs-plugins",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "pytest-cov",
            "specs": []
        },
        {
            "name": "essentials-openapi",
            "specs": [
                [
                    ">=",
                    "1.0.2"
                ]
            ]
        },
        {
            "name": "mkdocs",
            "specs": []
        },
        {
            "name": "flake8",
            "specs": []
        },
        {
            "name": "black",
            "specs": []
        },
        {
            "name": "isort",
            "specs": []
        },
        {
            "name": "flask",
            "specs": []
        }
    ],
    "lcname": "neoteroi-mkdocs"
}
        
Elapsed time: 0.34257s