Doxity - Simpleton Version

Documentation Generator for Solidity Contracts

Powered by Gatsby

This project is an attempt to create a working version of the @digix/doxity project.

Additional assistance in this fix was gleaned from ProjectWyvern

Getting Started

edit the following files to your desired parameters

• .doxityrc
• package.json

Load contracts

copy solidity contracts to the contracts folder

Build the docs

# clone this repo
git clone https://www.github.com/ryanhendricks/doxity-simpleton.git
# install doxity dependencies
cd doxity-simpleton/doxity
yarn
# return to root dir
cd ..
# install project dependencies from root folder
yarn
# build the docs
doxity build

Upload Docs to Github Pages

"author": "Ryan Hendricks",
"main": "docs/index.html",
"repository": {
    "type": "git",
    "url": "git+https://github.com/username/repo.git"
  },
"homepage": "https://tokenbnk.github.io/protocol/",

For a more in depth look at how this works and for additional commands please see: Original Readme

Demo Site