mkdocs-nbconvert

Name	mkdocs-nbconvert JSON
Version	0.4 JSON
	download
home_page	None
Summary	A MkDocs plug-in provides a source parser for *.ipynb Jupyter notebook files, base on nbconvert.
upload_time	2025-08-31 10:34:24
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	BSD-3-Clause
keywords	mkdocs mkdocs-plugin jupyter notebook jupyter-notebook markdown md nbconvert
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # mkdocs-nbconvert

[![PyPI](https://img.shields.io/pypi/v/mkdocs-nbconvert.svg)](https://pypi.org/project/mkdocs-nbconvert/)
[![GitHub tag (latest SemVer pre-release)](https://img.shields.io/github/v/tag/tanbro/mkdocs-nbconvert)](https://github.com/tanbro/mkdocs-nbconvert)
[![workflow](https://github.com/tanbro/mkdocs-nbconvert/actions/workflows/workflow.yml/badge.svg)](https://github.com/tanbro/mkdocs-nbconvert/actions/workflows/workflow.yml)

A [MkDocs][] plugin provides a source parser for `*.ipynb` [Jupyter][] Notebook files, based on [nbconvert][].

## References

- <https://tanbro.github.io/mkdocs-nbconvert/>
- <https://www.mkdocs.org/user-guide/plugins/>

## Build the Site

The project's documentation site serves as a demo of how to use it.

To build and serve the doc-site, run the following command in on a virtual environment:

```bash
pip install -e . --group dev
mkdocs serve
```

[MkDocs]: http://www.mkdocs.org/
[Jupyter]: https://jupyter.org/
[nbconvert]: https://pypi.org/project/nbconvert/

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mkdocs-nbconvert",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "mkdocs, mkdocs-plugin, jupyter, notebook, jupyter-notebook, markdown, md, nbconvert",
    "author": null,
    "author_email": "liu xue yan <liu_xue_yan@foxmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ea/f1/f40828fb9e57ca2129ac0549bd1b2bd37ed440be2f92762d99d3f09ceabf/mkdocs_nbconvert-0.4.tar.gz",
    "platform": null,
    "description": "# mkdocs-nbconvert\r\n\r\n[![PyPI](https://img.shields.io/pypi/v/mkdocs-nbconvert.svg)](https://pypi.org/project/mkdocs-nbconvert/)\r\n[![GitHub tag (latest SemVer pre-release)](https://img.shields.io/github/v/tag/tanbro/mkdocs-nbconvert)](https://github.com/tanbro/mkdocs-nbconvert)\r\n[![workflow](https://github.com/tanbro/mkdocs-nbconvert/actions/workflows/workflow.yml/badge.svg)](https://github.com/tanbro/mkdocs-nbconvert/actions/workflows/workflow.yml)\r\n\r\nA [MkDocs][] plugin provides a source parser for `*.ipynb` [Jupyter][] Notebook files, based on [nbconvert][].\r\n\r\n## References\r\n\r\n- <https://tanbro.github.io/mkdocs-nbconvert/>\r\n- <https://www.mkdocs.org/user-guide/plugins/>\r\n\r\n## Build the Site\r\n\r\nThe project's documentation site serves as a demo of how to use it.\r\n\r\nTo build and serve the doc-site, run the following command in on a virtual environment:\r\n\r\n```bash\r\npip install -e . --group dev\r\nmkdocs serve\r\n```\r\n\r\n[MkDocs]: http://www.mkdocs.org/\r\n[Jupyter]: https://jupyter.org/\r\n[nbconvert]: https://pypi.org/project/nbconvert/\r\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "A MkDocs plug-in provides a source parser for *.ipynb Jupyter notebook files, base on nbconvert.",
    "version": "0.4",
    "project_urls": {
        "Documentation": "https://tanbro.github.io/mkdocs-nbconvert",
        "Homepage": "https://tanbro.github.io/mkdocs-nbconvert",
        "Repository": "https://github.com/tanbro/mkdocs-nbconvert"
    },
    "split_keywords": [
        "mkdocs",
        " mkdocs-plugin",
        " jupyter",
        " notebook",
        " jupyter-notebook",
        " markdown",
        " md",
        " nbconvert"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "73593a006752a7d0c45d75cdb7aa1d8d2197ed82a1fc75eb79b89e7282c889a0",
                "md5": "0814334af4a629b7bd6d60c238221df9",
                "sha256": "917ff7597955f1589221db4103eac53429fc5d410fd5cefff64a57bda108baea"
            },
            "downloads": -1,
            "filename": "mkdocs_nbconvert-0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0814334af4a629b7bd6d60c238221df9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7133,
            "upload_time": "2025-08-31T10:34:23",
            "upload_time_iso_8601": "2025-08-31T10:34:23.409078Z",
            "url": "https://files.pythonhosted.org/packages/73/59/3a006752a7d0c45d75cdb7aa1d8d2197ed82a1fc75eb79b89e7282c889a0/mkdocs_nbconvert-0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "eaf1f40828fb9e57ca2129ac0549bd1b2bd37ed440be2f92762d99d3f09ceabf",
                "md5": "7fa9f6dac1b70080f37c0c6fdb009882",
                "sha256": "d898176a76f1e304dc8e90d1051b03909385c0ce4d92c2ec3e967dfdb72dd5c8"
            },
            "downloads": -1,
            "filename": "mkdocs_nbconvert-0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "7fa9f6dac1b70080f37c0c6fdb009882",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7542,
            "upload_time": "2025-08-31T10:34:24",
            "upload_time_iso_8601": "2025-08-31T10:34:24.993689Z",
            "url": "https://files.pythonhosted.org/packages/ea/f1/f40828fb9e57ca2129ac0549bd1b2bd37ed440be2f92762d99d3f09ceabf/mkdocs_nbconvert-0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-31 10:34:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tanbro",
    "github_project": "mkdocs-nbconvert",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "mkdocs-nbconvert"
}