mkdocs-nbconvert

Name	mkdocs-nbconvert JSON
Version	0.3 JSON
	download
home_page	None
Summary	A MkDocs plug-in provides a source parser for *.ipynb Jupyter notebook files, base on nbconvert.
upload_time	2024-04-07 08:55:38
maintainer	None
docs_url	None
author	None
requires_python	None
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)

A [MkDocs][] plug-in provides a source parser for `*.ipynb` [Jupyter][] Notebook files, base on [nbconvert][].

## References

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

## Build the site

The project itself's documentation site is a demo of how to use it.

To build and serve the doc-site:

```bash
pip install -r requirements.txt
mkdocs serve
```

Then open `http://127.0.0.1:8000` in your browser.

[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": null,
    "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/94/9f/853e6c727b48f6b2531a6edfc1e7002d33c2d1de317d7220c9fe167aeaec/mkdocs-nbconvert-0.3.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\r\nA [MkDocs][] plug-in provides a source parser for `*.ipynb` [Jupyter][] Notebook files, base 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 itself's documentation site is a demo of how to use it.\r\n\r\nTo build and serve the doc-site:\r\n\r\n```bash\r\npip install -r requirements.txt\r\nmkdocs serve\r\n```\r\n\r\nThen open `http://127.0.0.1:8000` in your browser.\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.3",
    "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": "",
            "digests": {
                "blake2b_256": "83643c48ac64767ff8dddb9335cdb95d31e4f2b8e2c11fde40b82fc0a566e016",
                "md5": "51240f73703bfa9dc6668e38686ea807",
                "sha256": "2db3d9e48bd41b3571541bb6e9f721b2b7d84d575d3afc40270895f44c9016a2"
            },
            "downloads": -1,
            "filename": "mkdocs_nbconvert-0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "51240f73703bfa9dc6668e38686ea807",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6227,
            "upload_time": "2024-04-07T08:55:36",
            "upload_time_iso_8601": "2024-04-07T08:55:36.828860Z",
            "url": "https://files.pythonhosted.org/packages/83/64/3c48ac64767ff8dddb9335cdb95d31e4f2b8e2c11fde40b82fc0a566e016/mkdocs_nbconvert-0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "949f853e6c727b48f6b2531a6edfc1e7002d33c2d1de317d7220c9fe167aeaec",
                "md5": "a8a70a23a2d970608a80b29ee099064c",
                "sha256": "22341e2a2c4f33503b7c3bf049a8a7dc1658085ed0814f77944a24a88c9e6154"
            },
            "downloads": -1,
            "filename": "mkdocs-nbconvert-0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "a8a70a23a2d970608a80b29ee099064c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6790,
            "upload_time": "2024-04-07T08:55:38",
            "upload_time_iso_8601": "2024-04-07T08:55:38.709916Z",
            "url": "https://files.pythonhosted.org/packages/94/9f/853e6c727b48f6b2531a6edfc1e7002d33c2d1de317d7220c9fe167aeaec/mkdocs-nbconvert-0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-07 08:55:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tanbro",
    "github_project": "mkdocs-nbconvert",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "mkdocs-nbconvert"
}