{"id":14563546,"url":"https://github.com/HQ20/soldoc","last_synced_at":"2025-09-04T06:32:09.118Z","repository":{"id":34997645,"uuid":"174625056","full_name":"HQ20/soldoc","owner":"HQ20","description":"A solidity documentation generator, based in NatSpec format. :page_with_curl: with standalone HTML, pdf, gitbook and docsify output :pencil2: just plug and play.","archived":false,"fork":false,"pushed_at":"2023-01-06T01:51:03.000Z","size":4479,"stargazers_count":64,"open_issues_count":32,"forks_count":9,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-09-05T16:48:06.736Z","etag":null,"topics":["doc","docgen","docsify","document","documentation","documentation-tool","gitbook","html","pdf","pdf-generation","smart-contracts","soldoc","solidity","solidity-contracts","solidity-documentation"],"latest_commit_sha":null,"homepage":"https://soldoc-demo.netlify.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HQ20.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2019-03-08T23:30:10.000Z","updated_at":"2024-09-03T03:27:45.000Z","dependencies_parsed_at":"2023-01-15T11:44:21.237Z","dependency_job_id":null,"html_url":"https://github.com/HQ20/soldoc","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HQ20%2Fsoldoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HQ20%2Fsoldoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HQ20%2Fsoldoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HQ20%2Fsoldoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HQ20","download_url":"https://codeload.github.com/HQ20/soldoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":217770648,"owners_count":16227639,"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":["doc","docgen","docsify","document","documentation","documentation-tool","gitbook","html","pdf","pdf-generation","smart-contracts","soldoc","solidity","solidity-contracts","solidity-documentation"],"created_at":"2024-09-07T02:02:28.591Z","updated_at":"2024-09-07T02:07:19.329Z","avatar_url":"https://github.com/HQ20.png","language":"JavaScript","funding_links":[],"categories":["solidity"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg width=\"768\" src=\"soldoc.png\"\u003e\n\u003c/div\u003e\n\n\u003e soldoc is a solidity documentation generator. This generator was created due to a need of giving documentation to developers and clients. Thinking about it, we first created this tool to generate a standalone HTML page, but then we also decided to generate a PDF.\n\n\u003cdiv align=\"center\"\u003e\n    \u003cdiv\u003e\n        \u003ca\n            href=\"https://www.npmjs.com/package/soldoc\"\u003e\u003cimg\n                src=\"https://img.shields.io/npm/dm/soldoc.svg\" /\u003e\u003c/a\u003e\u0026emsp;\n        \u003ca\n            href=\"https://travis-ci.org/HQ20/soldoc\"\u003e\u003cimg\n                src=\"https://travis-ci.org/HQ20/soldoc.svg?branch=master\" /\u003e\u003c/a\u003e\u0026emsp;\n        \u003ca\n            href=\"https://coveralls.io/github/HQ20/soldoc?branch=master\"\u003e\u003cimg\n                src=\"https://coveralls.io/repos/github/HQ20/soldoc/badge.svg?branch=master\" /\u003e\u003c/a\u003e\u0026emsp;\n        \u003ca\n            href=\"https://app.netlify.com/sites/soldoc-demo/deploys\"\u003e\u003cimg\n                src=\"https://api.netlify.com/api/v1/badges/084d2d9e-5f67-46c8-a8e7-22d73f2f707d/deploy-status\" /\u003e\u003c/a\u003e\u0026emsp;\n        \u003ca\n            href=\"https://dependabot.com\"\u003e\u003cimg\n                src=\"https://api.dependabot.com/badges/status?host=github\u0026repo=HQ20/soldoc\" /\u003e\u003c/a\u003e\u0026emsp;\n    \u003c/div\u003e\n\u003c/div\u003e\n\nSee demo [here](https://soldoc-demo.netlify.com/).\n\nPlease note that, there's also a pdf example in `./example` folder. This pdf is a first draft. We intend to have a better template and open the opportunity to get new templates.\n\n## Features\n* Generates documentation with soft colors :eyes:\n* The generated output can be standalone HTML :grin:, a PDF file :necktie:, gitbook format :scream: or docsify format :boom:\n* All formats support emojis :speak_no_evil:\n* Ignore documentation generator for some specific files :sunglasses:\n* Really fast :rabbit2:\n\n## Installation and Usage\n\n```bash\n# Go to your project folder.\ncd project-folder/\n\n# Install soldoc.\nnpm install --save-dev soldoc\n\n# Install soldoc's peerDependencies (in case you don't have them yet).\nnpm install --save-dev directory-tree highlight.js markdown-it markdown-it-emoji meow mustache node-emoji pdf-from-html\n\n# Run soldoc.\nnpx soldoc docs/ Sample.sol\n\n# View documentation\nopen ./docs/Sample.html\n```\n\nsoldoc supports many output formats, being pure HTML the default one.\n\nUse `soldoc --help` to get more information about output formats and other options.\n\n## Use internally\n\nYour can also use soldoc within your project\n```ts\nimport { generate } from 'soldoc';\n\ngenerate(outputType: string, ignoreFilesList: string[], outputFolder: string, inputPath: string)\n```\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n[GPL-3.0](LICENSE)\n\n## Credits\nCredits to all external open/free material used.\n\nThank you all.\n\nThe [sun](https://www.iconfinder.com/icons/2995005/giallo_sole_soleggiato_sun_sunny_weather_yellow_icon), the [A Directory Tree List Style A PEN BY Alex Raven](https://codepen.io/asraven/pen/qbrQMX), the [Font Family](https://www.dafont.com/pt/subscriber.font). As well as [Connor](https://github.com/connorltodd), who drafted the initial HTML template, and [zlocate](https://github.com/zlocate)\n\nThank you. Danke. Merci. Grazie. Gracias. Arigato. Obrigado.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHQ20%2Fsoldoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHQ20%2Fsoldoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHQ20%2Fsoldoc/lists"}