https://github.com/mkdocstrings/griffe2md

Output API docs to Markdown using Griffe.
https://github.com/mkdocstrings/griffe2md

api docs griffe markdown

Last synced: 26 days ago
JSON representation

Output API docs to Markdown using Griffe.

• Host: GitHub
• URL: https://github.com/mkdocstrings/griffe2md
• Owner: mkdocstrings
• License: isc
• Created: 2023-05-11T14:43:25.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2026-02-05T16:39:11.000Z (about 1 month ago)
• Last Synced: 2026-02-06T02:54:39.902Z (about 1 month ago)
• Topics: api, docs, griffe, markdown
• Language: Python
• Homepage: https://mkdocstrings.github.io/griffe2md/
• Size: 1.9 MB
• Stars: 16
• Watchers: 1
• Forks: 4
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# griffe2md

[![ci](https://github.com/mkdocstrings/griffe2md/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe2md/actions?query=workflow%3Aci)

[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe2md/)

[![pypi version](https://img.shields.io/pypi/v/griffe2md.svg)](https://pypi.org/project/griffe2md/)

[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#griffe2md:gitter.im)

Output API docs to Markdown using Griffe.

## Installation

```bash

pip install griffe2md

```

With [`uv`](https://docs.astral.sh/uv/):

```bash

uv tool install griffe2md

```

## Usage

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

```bash

griffe2md markdown

griffe2md path/to/my/src/package

```

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

```bash

griffe2md markdown -o markdown.md

```

`griffe2md` can be configured in either `pyproject.toml` or a `griffe2md.toml` file. The latter can be placed in a `.config` or `config` directory in the project root.

`griffe2md.toml` file is structured as a simple key-value dictionary, e.g.:

```toml

docstring_style = "sphinx"

```

If you configure it in `pyproject.toml`, the configuration should go under the `tool.griffe2md` key:

```toml

[tool.griffe2md]

docstring_style = "sphinx"

```

See [the documentation](https://mkdocstrings.github.io/griffe2md/reference/griffe2md/config/#griffe2md.config.ConfigDict) for reference.

## Sponsors





Silver sponsors











Bronze sponsors











---





































































*And 7 more private sponsor(s).*