# Remix EthDoc Plugin

The Remix EthDoc plugin allow you to generate HTML documents from solidity smart contracts. It also gives you the capability to publish the generated HTML documents to IPFS.

## Activate

To be able to work with the plugin go to the plugins section and find EthDoc, then activate it.

## How to generate documentation

To generate HTML documents, the first thing you need to do is to compile smart contracts.

Once the contracts are compiled, go to the EthDoc plugin section and you can select and preview the HTML documents that were generated.

## How to publish

In order to publish an HTML document, you need to first select a generated HTML document and then click the "Publish" button.

Then, you should be redirected to the published version of the HTML document.

## Issues

If you have any issues, please feel free to create an issue in our [Github repository](https://github.com/Machinalabs/remix-ethdoc-plugin/issues).