Skip to content

📑 A tool for generating formatted Solidity Smart Contract documentation programmatically

License

Notifications You must be signed in to change notification settings

nexeth/solidity-docgen

Repository files navigation

@nexeth/solidity-docgen

@nexeth/solidity-docgen is a tool for generating formatted Solidity Smart Contract documentation programmatically.

Getting Started

Install bun

If you haven't already, install bun. Follow the directions here

Linting

To lint your code:

bun lint

Testing

To run tests:

bun test

Contributing

If you have suggestions, bug reports, or would like to contribute to this project template, please open an issue or submit a pull request on the GitHub repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

📑 A tool for generating formatted Solidity Smart Contract documentation programmatically

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published