Skip to content

Commit

Permalink
Fix typo in README.md (storyprotocol#308)
Browse files Browse the repository at this point in the history
  • Loading branch information
sky-coderay authored Nov 15, 2024
1 parent fd96a09 commit a0ba5f6
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ We use [solidity-docgen](https://github.com/OpenZeppelin/solidity-docgen) to gen
npx hardhat docgen
```

By default, the documents are generated in Markdown format in the `doc` folder of the project. Each Solidity file (`*.sol`) has its own Markdown (`*.md`) file. To update the configuration for document generation, you can update the following section in `harhat.config.js`:
By default, the documents are generated in Markdown format in the `doc` folder of the project. Each Solidity file (`*.sol`) has its own Markdown (`*.md`) file. To update the configuration for document generation, you can update the following section in `hardhat.config.js`:

```
docgen: {
Expand All @@ -182,4 +182,4 @@ docgen: {
}
```

You can refer to the [config.ts](https://github.com/OpenZeppelin/solidity-docgen/blob/master/src/config.ts) of solidity-docgen for the full list of configurable parameters.
You can refer to the [config.ts](https://github.com/OpenZeppelin/solidity-docgen/blob/master/src/config.ts) of solidity-docgen for the full list of configurable parameters.

0 comments on commit a0ba5f6

Please sign in to comment.