https://github.com/tanbro/mkdocs-nbconvert

A MkDocs plug-in provides a source parser for *.ipynb files
https://github.com/tanbro/mkdocs-nbconvert

jupyter jupyter-notebook markdown mkdocs mkdocs-plugin nbconvert notebook notebook-publish

Last synced: 3 months ago
JSON representation

A MkDocs plug-in provides a source parser for *.ipynb files

• Host: GitHub
• URL: https://github.com/tanbro/mkdocs-nbconvert
• Owner: tanbro
• License: bsd-2-clause
• Created: 2019-08-05T11:11:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-21T11:54:34.000Z (3 months ago)
• Last Synced: 2024-10-21T16:45:58.244Z (3 months ago)
• Topics: jupyter, jupyter-notebook, markdown, mkdocs, mkdocs-plugin, nbconvert, notebook, notebook-publish
• Language: Jupyter Notebook
• Size: 3.12 MB
• Stars: 9
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

        
# 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][] plug-in provides a source parser for `*.ipynb` [Jupyter][] Notebook files, base on [nbconvert][].

## References

- 

- 

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