From 162b406ea28aa5bacc34a00745d8780bcbf58753 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Wed, 27 May 2026 14:55:28 -0400 Subject: add better syntax highlighting for code blocks --- docs/dev/documentation.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'docs/dev/documentation.md') diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md index 74129884..75817f16 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -14,13 +14,15 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li ## Building - git clone https://github.com/Vector35/binaryninja-api/ - cd binaryninja-api - properdocs build - echo User documentation available in site/ - cd api-docs - make html - echo API documentation available in build/html +```bash +git clone https://github.com/Vector35/binaryninja-api/ +cd binaryninja-api +properdocs build +echo User documentation available in site/ +cd api-docs +make html +echo API documentation available in build/html +``` ## Changing Changing documentation for the API itself is fairly straightforward. Use [doxygen style comment blocks](https://www.doxygen.nl/manual/docblocks.html) in C++ and C, and [restructured text blocks](https://sphinx-tutorial.readthedocs.io/step-1/) for python for the source. The user documentation is located in the `api/docs/` folder and the API documentation is generated from the config in the `api/api-docs` folder. -- cgit v1.3.1