{"repo":"CYBRToken/solidoc","free":true,"listed":false,"github":"https://github.com/CYBRToken/solidoc","clone":"git clone https://github.com/CYBRToken/solidoc.git","description":"Solidity Documentation Generator","language":"JavaScript","stars":12,"topics":["solidity","natspec","documentation","documentation-tool","documentation-generator","markdown","ethereum","eth","ethereum-classic","etc"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"Solidoc: Documentation Generator for Solidity This command-line utility creates markdown-based documentation for your Solidity project(s) for the following platforms: Ethereum Ethereum Classic Tron Qtum Wanchain Aeternity Counterparty Rootstock Ubiq Monax Getting Started CLI Arguments 1. Path to truffle project (or similar) root. 2. Path to generate documentation to. 3. Do not recompile. Optional, default: false. 4. Language. Optional, default: en. How to Use Solidoc? On your project root, run the following command. This will generate documentation to the docs directory. Or edit package.json and run Note Do not use recompilation (third argument) if you are using this on a non truffle project. Configuration File Alternatively, you can create solidoc.json configuration file in your project root. and then call solidoc instead of passing any command line argument. Overrides If you wish to change bits and pieces of the documentation generated, place solidoc templates on the following directory: ./.solidoc/templates/ Solidoc Templates You can also override language literals by copying and editing i18n files on the following path: ./.solidoc/i18n/ Before You Try - OpenZeppelin Solidity Documentation - Open Source Vesting Schedule by Binod - Virtual Rehab Token - Virtual Rehab Private Sale","default_branch":null,"files":null,"tree":[],"storefront":"/r/CYBRToken","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/CYBRToken/solidoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}