Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

PyPI version Python versions Travis AppVeyor Coverage Status Code style: black

Pheasant

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. In addition to the code execution, Pheasant can automatically number headers, figures, tables, etcs.

Setup

Install the plugin using pip:

pip install pheasant

Next, add the following lines to your mkdocs.yml:

plugins:
  - search
  - pheasant

If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set.

Documentation

See Pheasant documentation.

About

Documentation tool for Markdown conversion by Jupyter client

Topics

Resources

License

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •