https://github.com/mkdocstrings/c

A C handler for mkdocstrings. Available to sponsors only.
https://github.com/mkdocstrings/c

c mkdocs mkdocstrings mkdocstrings-collector mkdocstrings-handler

Last synced: 26 days ago
JSON representation

A C handler for mkdocstrings. Available to sponsors only.

• Host: GitHub
• URL: https://github.com/mkdocstrings/c
• Owner: mkdocstrings
• Created: 2024-05-22T16:23:34.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-08-04T13:37:21.000Z (9 months ago)
• Last Synced: 2024-10-16T13:06:55.232Z (7 months ago)
• Topics: c, mkdocs, mkdocstrings, mkdocstrings-collector, mkdocstrings-handler
• Homepage: https://mkdocstrings.github.io/c
• Size: 474 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# mkdocstrings-c

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

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

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

[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#c:gitter.im)

A C handler for mkdocstrings.

WARNING: **Still in prototyping phase!**

Feedback is welcome.

NOTE: **C99 full support, C11 partial support**

Since data is extraced with [pycparser](https://github.com/eliben/pycparser), only C99 is fully supported, while C11 is partially supported.

## Installation

```bash

pip install mkdocstrings-c

```

## Usage

With the following header file:

```c title="hello.h"

--8<-- "docs/snippets/hello.h"

```

Generate docs for this file with this instruction in one of your Markdown page:

```md

::: path/to/hello.h

```

This will generate the following HTML:

::: docs/snippets/hello.h

    handler: c