Metadata-Version: 2.4
Name: mkdocs-nbconvert
Version: 0.4
Summary: A MkDocs plug-in provides a source parser for *.ipynb Jupyter notebook files, base on nbconvert.
Author-email: liu xue yan <liu_xue_yan@foxmail.com>
License: BSD-3-Clause
Project-URL: Homepage, https://tanbro.github.io/mkdocs-nbconvert
Project-URL: Repository, https://github.com/tanbro/mkdocs-nbconvert
Project-URL: Documentation, https://tanbro.github.io/mkdocs-nbconvert
Keywords: mkdocs,mkdocs-plugin,jupyter,notebook,jupyter-notebook,markdown,md,nbconvert
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Documentation
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: mkdocs>=1.6
Requires-Dist: nbconvert>=4.2
Requires-Dist: typing-extensions>=4.5.0; python_version < "3.12"
Dynamic: license-file

# 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/
