https://github.com/daizutabi/pheasant
Documentation tool for Markdown conversion by Jupyter client
https://github.com/daizutabi/pheasant
html jupyter jupyter-kernels markdown
Last synced: about 1 year ago
JSON representation
Documentation tool for Markdown conversion by Jupyter client
- Host: GitHub
- URL: https://github.com/daizutabi/pheasant
- Owner: daizutabi
- License: mit
- Created: 2017-12-25T12:14:27.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-03-22T21:04:45.000Z (over 1 year ago)
- Last Synced: 2025-03-22T22:19:03.963Z (over 1 year ago)
- Topics: html, jupyter, jupyter-kernels, markdown
- Language: Python
- Homepage: https://pheasant.daizutabi.net/
- Size: 6.79 MB
- Stars: 16
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pheasant
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Python Version][python-v-image]][python-v-link]
[![Build Status][GHAction-image]][GHAction-link]
[![Coverage Status][codecov-image]][codecov-link]
Pheasant is a Markdown converter which is designed to be used as a plugin
for static site generators, especially MkDocs. The one of the main features
of Pheasant is auto Markdown generation of outputs after execution of any
Python or other language codes written in a fenced code block of Markdown source.
This process is executed by the Jupyter client functionality.
## Setup
Install the plugin using pip:
```bash
pip install pheasant
```
Next, add the following lines to your `mkdocs.yml`:
```yml
plugins:
- search
- pheasant
```
[pypi-v-image]: https://img.shields.io/pypi/v/pheasant.svg
[pypi-v-link]: https://pypi.org/project/pheasant/
[python-v-image]: https://img.shields.io/pypi/pyversions/pheasant.svg
[python-v-link]: https://pypi.org/project/pheasant
[GHAction-image]: https://github.com/daizutabi/pheasant/actions/workflows/ci.yml/badge.svg?branch=main&event=push
[GHAction-link]: https://github.com/daizutabi/pheasant/actions?query=event%3Apush+branch%3Amain
[codecov-image]: https://codecov.io/github/daizutabi/pheasant/coverage.svg?branch=main
[codecov-link]: https://codecov.io/github/daizutabi/pheasant?branch=main