From 9b47a623795003e48b0311fdf4bb199a10f37028 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Thu, 7 May 2026 11:33:50 -0400 Subject: Swap mkdocs for properdocs in docs --- docs/about/open-source.md | 6 +++--- docs/dev/documentation.md | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) (limited to 'docs') diff --git a/docs/about/open-source.md b/docs/about/open-source.md index d7a37b4c..ea7e3a24 100644 --- a/docs/about/open-source.md +++ b/docs/about/open-source.md @@ -9,7 +9,7 @@ Vector 35 is grateful for the following open source packages that are used in Bi - [breathe] ([breathe license] - BSD) - [doxygen] ([doxygen license] - GPLv2) - [mkdocs-material] ([mkdocs-material License] - BSD) - - [mkdocs] ([mkdocs license] - BSD) + - [properdocs] ([properdocs license] - BSD) - [sphinx] ([sphinx license] - BSD and others) The previous tools are used in the generation of our documentation, but are not distributed themselves and are merely listed here in acknowledgement for the value they provide. @@ -122,10 +122,10 @@ Please note that we offer no support for running Binary Ninja with modified Qt l [llvm license]: http://llvm.org/releases/3.8.1/LICENSE.TXT [lzf license]: http://oldhome.schmorp.de/marc/liblzf.html [lzf]: http://oldhome.schmorp.de/marc/liblzf.html -[mkdocs license]: https://github.com/mkdocs/mkdocs/blob/master/LICENSE +[properdocs license]: https://github.com/properdocs/properdocs/blob/master/LICENSE [mkdocs-material license]: https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE [mkdocs-material]: https://github.com/squidfunk/mkdocs-material -[mkdocs]: http://www.mkdocs.org/ +[properdocs]: https://properdocs.org/ [opensans license]: https://fonts.google.com/specimen/Open+Sans/license [opensans]: https://fonts.google.com/specimen/Open+Sans [PPC architecture module]: https://github.com/Vector35/ppc-capstone 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 -- cgit v1.3.1