neoteroi-mkdocs


Nameneoteroi-mkdocs JSON
Version 1.0.4 PyPI version JSON
download
home_page
SummaryPlugins for MkDocs and Python Markdown
upload_time2023-07-28 10:47:24
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords markdown mkdocs openapi swagger documentation extensions plugins
VCS
bugtrack_url
requirements No requirements were recorded.
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": "",
    "name": "neoteroi-mkdocs",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "Markdown,MkDocs,OpenAPI,Swagger,documentation,extensions,plugins",
    "author": "",
    "author_email": "Roberto Prevato <roberto.prevato@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/a0/91/4a225a4afb068262f3b7c6bf9452e85c1394de1b356e685964479d88ae9f/neoteroi_mkdocs-1.0.4.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": "",
    "summary": "Plugins for MkDocs and Python Markdown",
    "version": "1.0.4",
    "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": "71f76988f0d5270da2b0483e443961014eccdb824df4e992bc15eb2f6ecd0818",
                "md5": "43dd08aa28ca74c57a6fb801cc39a705",
                "sha256": "ed2b93a206173b10cd5635e050ce0d8e83df0e51cfd5ee6d41751bfcaa4fe197"
            },
            "downloads": -1,
            "filename": "neoteroi_mkdocs-1.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "43dd08aa28ca74c57a6fb801cc39a705",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 38041,
            "upload_time": "2023-07-28T10:47:22",
            "upload_time_iso_8601": "2023-07-28T10:47:22.907506Z",
            "url": "https://files.pythonhosted.org/packages/71/f7/6988f0d5270da2b0483e443961014eccdb824df4e992bc15eb2f6ecd0818/neoteroi_mkdocs-1.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a0914a225a4afb068262f3b7c6bf9452e85c1394de1b356e685964479d88ae9f",
                "md5": "a6e94f93269ecd4f9d7f9d420cdd159a",
                "sha256": "3825bcecc4b2c7755ef6adbf96d754762dafd76db508fdd3a23533c88e744228"
            },
            "downloads": -1,
            "filename": "neoteroi_mkdocs-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "a6e94f93269ecd4f9d7f9d420cdd159a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 24780,
            "upload_time": "2023-07-28T10:47:24",
            "upload_time_iso_8601": "2023-07-28T10:47:24.439532Z",
            "url": "https://files.pythonhosted.org/packages/a0/91/4a225a4afb068262f3b7c6bf9452e85c1394de1b356e685964479d88ae9f/neoteroi_mkdocs-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-28 10:47:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Neoteroi",
    "github_project": "mkdocs-plugins",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "neoteroi-mkdocs"
}
        
Elapsed time: 0.10587s