ethereum / remix-ide

Documentation for Remix IDE

Remix

This repository contain only Remix's official Read the Docs documentation source code. Documentation is available here.

If looking for Remix IDE codebase, it has been moved to https://github.com/ethereum/remix-project

About Remix Project

Remix Project is a platform for development tools that use a plugin architecture. It encompasses sub-projects including Remix Plugin Engine, Remix Libraries, and of course Remix IDE.

Remix IDE is an open source web and desktop application. It fosters a fast development cycle and has a rich set of plugins with intuitive GUIs. Remix is used for the entire journey of contract development with Solidity language as well as a playground for learning and teaching Ethereum.

Start developing using Remix on browser, visit: https://remix.ethereum.org

For desktop version, see releases: https://github.com/ethereum/remix-desktop/releases

Remix libraries work as a core of native plugins of Remix IDE. Read more about libraries here

Build

Steps to build this project as as:

pip3 install sphinx sphinx_rtd_theme
pip3 install myst-parser
git clone https://github.com/ethereum/remix-ide.git
cd docs/
make html

Go to docs/_build/html and open index.html on the browser.

Contributing

We wholeheartedly welcome everyone to contribute. Suggestions, issues, queries and feedback are our pleasure. Please join our Discord server.

Translating

The site is internationalized. Do not make any corrections to .po or .pot files. These get handled in our translation management platform. To help with the translation of our documentation, please visit https://crowdin.com/project/remix-translation. To help with our translations of Remix's UI, please visit https://crowdin.com/project/remix-ui.