added markup generator

.gitignore

@@ -7,6 +7,7 @@ cache
 artifacts
 coverage.json
 coverage
+generated-markups
 
 # IDE files
 .idea

README.md

@@ -13,7 +13,7 @@ The library consists of modules and utilities that are built with a help of [Ope
 - Versatile **RBAC** smart contract
 - Enhanced and simplified [**Diamond**](https://eips.ethereum.org/EIPS/eip-2535) pattern
 - Heap based priority queue library
-- Memory data structures
+- Memory data structures (Vector)
 - Utilities to ease work with ERC20 decimals, arrays, and sets
 
 ## Overview

hardhat.config.js

@@ -1,5 +1,6 @@
 require("@nomiclabs/hardhat-web3");
 require("@nomiclabs/hardhat-truffle5");
+require("@dlsl/hardhat-markup");
 require("hardhat-contract-sizer");
 require("hardhat-gas-reporter");
 require("solidity-coverage");
@@ -33,6 +34,9 @@ module.exports = {
       bsc: `${process.env.BSCSCAN_KEY}`,
     },
   },
+  markup: {
+    onlyFiles: ["./contracts/"],
+  },
   mocha: {
     timeout: 1000000,
   },

package.json

@@ -24,6 +24,7 @@
     "lint-json-fix": "prettier --write \"./[a-zA-Z0-9.]+(?!-lock).json\"",
     "lint-js-fix": "prettier --write \"./**/*.js\"",
     "lint-sol-fix": "prettier --write \"contracts/**/*.sol\"",
+    "generate-docs": "npx hardhat markup",
     "publish-to-npm": "npm run lint-fix && bash ./scripts/publish.sh"
   },
   "dependencies": {
@@ -32,6 +33,7 @@
     "hardhat": "^2.13.0"
   },
   "devDependencies": {
+    "@dlsl/hardhat-markup": "^1.0.0-rc.10",
     "@metamask/eth-sig-util": "^4.0.0",
     "@nomiclabs/hardhat-truffle5": "^2.0.1",
     "@nomiclabs/hardhat-web3": "^2.0.0",
@@ -41,14 +43,14 @@
     "hardhat-contract-sizer": "^2.1.1",
     "hardhat-gas-reporter": "^1.0.4",
     "husky": "^7.0.2",
+    "merkletreejs": "^0.3.9",
     "mocha": "^9.1.1",
     "prettier": "^2.7.1",
     "prettier-plugin-solidity": "^1.0.0",
     "solhint": "^3.3.6",
     "solhint-plugin-prettier": "^0.0.5",
     "solidity-coverage": "^0.8.2",
     "truffle-assertions": "^0.9.2",
-    "web3": "^1.7.5",
-    "merkletreejs": "^0.3.9"
+    "web3": "^1.7.5"
   }
 }