mirror
/
remix-project
mirror of https://github.com/ethereum/remix-project.git
2
0
Fork 0
Code Issues Releases Wiki Activity
remix-project mirror
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
21353 Commits
626 Branches
161 Tags
314 MiB
 
 
 
 
 
Tag: Branch: Tree: cf58e05707
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'cf58e05707'
${ noResults }
remix-project/docs/index.md

29 lines
1.3 KiB
Raw Blame History

# 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
This plugin consist of 2 parts, what is call the EthDoc viewer and the EthdDoc generator. Internally the EthDoc Generator will activate the EthDoc viewer, so you only need to go to the plugins section and find EthDoc, then activate it and automatically EthDoc viewer will be active.
The following image illustrate both sections of the plugin.
![Screenshot](img/ethdoc.png)
The EthDoc viewer appears in a tab in the main area of the Remix Editor and the EthDoc generator will appear in the side panel.
## 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).