summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorJordan Wiens <github@psifertex.com>2026-05-07 11:33:50 -0400
committerJordan Wiens <github@psifertex.com>2026-05-07 11:39:14 -0400
commit9b47a623795003e48b0311fdf4bb199a10f37028 (patch)
tree33e05a91230b30e58aa5d41b6df9b00478b2a804 /docs/dev
parentdc2a8e2de09b14c88cde7865f2c3e8f655b68f8d (diff)
Swap mkdocs for properdocs in docs
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/documentation.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md
index 08053c24..bc0a445e 100644
--- a/docs/dev/documentation.md
+++ b/docs/dev/documentation.md
@@ -8,15 +8,15 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li
- [sphinx]
- [breathe]
-- [mkdocs]
+- [properdocs]
- [doxygen]
-- The following mkdocs plugins: `mkdocs-callouts mkdocs-click mkdocs-include-markdown-plugin mkdocs-material mkdocs-glightbox mkdocs-htmlproofer-plugin mkdocs-redirects`
+- The following plugins: `mkdocs-callouts mkdocs-click mkdocs-include-markdown-plugin mkdocs-material mkdocs-glightbox mkdocs-htmlproofer-plugin mkdocs-redirects`
## Building
git clone https://github.com/Vector35/binaryninja-api/
cd binaryninja-api
- mkdocs build
+ properdocs build
echo User documentation available in site/
cd api-docs
make html
@@ -26,11 +26,11 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li
Changing documentation for the API itself is fairly straight forward. 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.
???+ Info "Tip"
- When updating user documentation, the `mkdocs serve` feature is particularly helpful.
+ When updating user documentation, the `properdocs serve` feature is particularly helpful.
[contribution license agreement]: https://binary.ninja/cla.pdf
[Vector 35]: https://vector35.com/
-[mkdocs]: http://www.mkdocs.org/
+[properdocs]: https://properdocs.org/
[breathe]: https://github.com/michaeljones/breathe
[sphinx]: https://www.sphinx-doc.org/en/master/
[doxygen]: https://www.doxygen.nl