pheasant

KO | EN

gitlite — search

#python #hacktoberfest #typescript #llm #go #golang #android #docker #nodejs #macos #windows #vue #awesome-list #open-source

(★ 16)

Documentation tool for Markdown conversion by Jupyter client

pheasant 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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

pheasant

pheasant 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

pheasant

pheasant 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README