Metadata-Version: 2.1
Name: mkdocs-nbconvert
Version: 0.1.3
Summary: A MkDocs plug-in provides a source parser for *.ipynb files
Home-page: https://tanbro.github.io/mkdocs-nbconvert
Author: liu xue yan
Author-email: liu_xue_yan@foxmail.com
License: BSD 3-Clause License
Project-URL: Documentation, https://tanbro.github.io/mkdocs-nbconvert
Project-URL: Source, https://github.com/tanbro/mkdocs-nbconvert
Keywords: mkdocs,mkdocs-plugin,jupyter,notebook,jupyter-notebook,markdown,md,nbconvert
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Documentation
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# mkdocs-nbconvert

[![PyPI](https://img.shields.io/pypi/v/mkdocs-nbconvert.svg)](https://pypi.org/project/mkdocs-nbconvert/)
[![PyPI - Status](https://img.shields.io/pypi/status/mkdocs-nbconvert)](https://pypi.org/project/mkdocs-nbconvert/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-nbconvert.svg)](https://pypi.org/project/mkdocs-nbconvert/)
[![PyPI - Format](https://img.shields.io/pypi/format/mkdocs-nbconvert.svg)](https://pypi.org/project/mkdocs-nbconvert/)

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

## Features

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

## Build the documentation

The project itself's documentation site is a demo of how to use is in [MkDocs][].

To serve it:

```bash
mkdocs serve -a 127.0.0.1:8080
```

Then open `http://127.0.0.1:8080` with your browser.

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

# Contributing

# Changelog

## v0.1.3

Date: 2022-04-18

- Changes:
  - Switch to BSD 2-Clause License, and add the license file to repo.
  - Drop supports of old python (<=3.6))
  - Change the package's build system to PEP517

## v0.1.2

- Date: 2020-07-17

  - New documentation site
  - `kwargs` to plugin method

## v0.1

- Date: 2020-01-16

A very early alpha version, not for production.

# Authors

liu xue yan <liu_xue_yan@foxmail.com>


