https://github.com/finsberg/clang-format-docs

Run `clang-format` on C++ code blocks in documentation files
https://github.com/finsberg/clang-format-docs

Last synced: 3 days ago
JSON representation

Run `clang-format` on C++ code blocks in documentation files

• Host: GitHub
• URL: https://github.com/finsberg/clang-format-docs
• Owner: finsberg
• License: mit
• Created: 2022-10-19T10:21:51.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-20T13:28:58.000Z (9 months ago)
• Last Synced: 2024-09-24T01:59:02.613Z (about 2 months ago)
• Language: Python
• Size: 34.2 KB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
clang-format-docs

=================

Run `clang-format` on C++ code blocks in documentation files.

This project is derivative work of [`blacken-docs`](https://github.com/adamchainz/blacken-docs). License from `blacken-docs` is included in [LICENSE_blacken_docs](LICENSE_blacken_docs)

## install

```bash

pip install clang-format-docs

```

## Usage

`clang-format-docs` will take markdown files and search for C++ code blocks e.g

```markdown

    ```c++

    void hello(){

        std::cout << "Hello world\n";

    }

    ```

```

and format them using `clang-format`, i.e

```bash

clang-format-docs file.md

```

will rewrite the file with clang-format applied. Also note that you can pass in a different format style using

```

clang-format-docs --style=LLVM file.md

```

or using a clang-format config file

```

clang-format-docs --style=file:my_clang_format.txt file.md

```

## Usage with pre-commit

See [pre-commit](https://pre-commit.com) for instructions

Sample `.pre-commit-config.yaml`:

```yaml

-   repo: https://github.com/finsberg/clang-format-docs

    rev: v0.3.0

    hooks:

    -   id: clang-format-docs

        additional_dependencies: [clang-format==14.0.6]

```