This README provides instructions for previewing the Sidekick documentation using mkdocs.
The source for the actual Sidekick plugin itself is proprietary, copyright Vector 35 and available via download through the Binary Ninja Plugin Manager rather than being hosted here on GitHub.
To preview this documentation, you will need to have mkdocs installed on your system. If you don't have it installed, you can install it by running the following command:
pip install mkdocsTo preview the documention:
-
Navigate to the
docsdirectory. -
Run the following command:
mkdocs serve
-
Open a web browser and navigate to http://localhost:8000.
This will start a development server and display a live preview of the documentation. You can edit the markdown files in the docs directory and the changes will be automatically reflected in the preview.
The license file (DOCS_LICENSE.txt) provided in this repository applies to the documentation in this repository.