{"id":20992234,"url":"https://github.com/bosonprotocol/solidoc","last_synced_at":"2025-03-13T12:27:09.777Z","repository":{"id":63691265,"uuid":"496147002","full_name":"bosonprotocol/solidoc","owner":"bosonprotocol","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-24T09:22:08.000Z","size":136,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-20T21:06:56.328Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bosonprotocol.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-25T08:32:59.000Z","updated_at":"2022-12-15T00:19:09.000Z","dependencies_parsed_at":"2023-01-22T07:49:04.701Z","dependency_job_id":null,"html_url":"https://github.com/bosonprotocol/solidoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bosonprotocol%2Fsolidoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bosonprotocol%2Fsolidoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bosonprotocol%2Fsolidoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bosonprotocol%2Fsolidoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bosonprotocol","download_url":"https://codeload.github.com/bosonprotocol/solidoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243403649,"owners_count":20285425,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T07:10:04.077Z","updated_at":"2025-03-13T12:27:09.756Z","avatar_url":"https://github.com/bosonprotocol.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Solidoc: Documentation Generator for Solidity\n\n[![npm version](https://badge.fury.io/js/%40thinkanddev%2Fsolidoc.svg)](https://www.npmjs.com/package/@thinkanddev/solidoc)\n\nThis command-line utility creates markdown-based documentation for your Solidity project(s) for the following platforms:\n\n* Ethereum\n* Ethereum Classic\n* Tron\n* Qtum\n* Wanchain\n* Aeternity\n* Counterparty\n* Rootstock\n* Ubiq\n* Monax\n* RSK\n\n## Supports Solidity up to 0.7.\nAble to also generate docs for events and state variables with tags like `@notice`, `@dev` and `@param`.\n\n## Getting Started\n\n**Global instalation**\n\n```npm\nsudo npm install solidoc -g\n```\n\n**Project instalation**\n\n```npm\nnpm install solidoc\n```\n\n**CLI Arguments**\n\n1. Path to Truffle project (or similar) root.\n2. Path to generate documentation to.\n3. Do not recompile. Optional, default: false.\n4. Compiler. Truffle compiler (use `npx truffle compiler` to use the same compiler as the project, instead of global install of Truffle).\n5. Language. Optional, default: en.\n6. Version. Optional, refers to contracts version (depends on the project).\n7. Ignore files. Optional, array with filenames to ignore.\n\nUsing a [configuration file](#configuration-file) is recommended (mostly if you want to ignore files).\n\n\n**How to Use Solidoc?**\n\nOn your project root, run the following command:\n\n```npm\nsolidoc ./ ./docs true\n```\n\nThis will generate documentation to the `docs` directory.\n\n**Or edit package.json**\n\n```json\n  \"scripts\": {\n    \"docgen\": \"solidoc ./ ./docs\"\n  }\n```\n\nand run:\n\n```npm\nnpm run docgen\n```\n\n**Note**\n\nDo not use recompilation (third argument) if you are using this on a non Truffle project.\n\n## Configuration File\n\nAlternatively, you can create `solidoc.json` configuration file in your project root:\n\n```json\n{\n  \"pathToRoot\": \"./\",\n  \"outputPath\": \"./docs\",\n  \"noCompilation\": true,\n  \"compiler\": \"truffle compile\",\n  \"language\": \"en\",\n  \"version\": \"0.1.10\",\n  \"ignoreFiles\": []\n}\n```\n\nand then call `solidoc` instead of passing any command line argument.\n\n\n## Overrides\n\nIf you wish to change bits and pieces of the documentation generated, place `solidoc templates` on the following directory:\n\n`./.solidoc/templates/`\n\n[Solidoc Templates](templates)\n\n\nYou can also override language literals by copying and editing `i18n` files on the following path:\n\n`./.solidoc/i18n/`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbosonprotocol%2Fsolidoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbosonprotocol%2Fsolidoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbosonprotocol%2Fsolidoc/lists"}