Skip to content

ISOR3X/griffe2md

 
 

Repository files navigation

Fork to format the output in a way that VitePress supports.

griffe2md

ci documentation pypi version gitter

Output API docs to Markdown using Griffe.

Installation

pip install griffe2md

With uv:

uv tool install griffe2md

Usage

Simply call griffe2md with a package name, or the path to a package folder:

griffe2md markdown
griffe2md path/to/my/src/package

Use the -o, --output option to write to a file instead of standard output:

griffe2md markdown -o markdown.md

About

Output API docs to Markdown using Griffe.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 64.5%
  • Jinja 34.9%
  • Other 0.6%