https://github.com/sambacha/go-natspec

generate html docs from solidity natspec
https://github.com/sambacha/go-natspec

ethereum natspec solidity

Last synced: 25 days ago
JSON representation

generate html docs from solidity natspec

• Host: GitHub
• URL: https://github.com/sambacha/go-natspec
• Owner: sambacha
• Created: 2022-06-29T08:30:35.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-12-05T12:12:02.000Z (12 months ago)
• Last Synced: 2024-10-12T08:16:00.378Z (about 1 month ago)
• Topics: ethereum, natspec, solidity
• Language: Go
• Homepage: https://sambacha.github.io/go-natspec/
• Size: 2.14 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [go-natspec](#)

## Requirements

- Pygments installed.   

- Pygments solidity lexer available  

### macOS

```shell

brew install pygments

```

[https://gitlab.com/veox/pygments-lexer-solidity/-/blob/master/pygments_lexer_solidity/lexer.py](https://gitlab.com/veox/pygments-lexer-solidity/-/blob/master/pygments_lexer_solidity/lexer.py)

## Usage

```shell

wget https://github.com/sambacha/go-natspec/releases/download/v0.0.1/dappspec

chmod +x dappspec

./dappspec test.sol

> dappspec:  test.sol  ->  docs/test.html

serve docs/

--> http://localhost:3000/test

```

Download binary.    

use binary on Solidity file.    

documents generated to docs/ dir (make sure this exists).