https://github.com/ethereum/remix-ide

Documentation for Remix IDE
https://github.com/ethereum/remix-ide

blockchain debugging debugging-tool documentation ethereum evm remix remix-ide smart-contracts solidity vyper

Last synced: 26 days ago
JSON representation

Documentation for Remix IDE

• Host: GitHub
• URL: https://github.com/ethereum/remix-ide
• Owner: ethereum
• Created: 2016-05-17T23:17:34.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-21T19:50:30.000Z (about 1 month ago)
• Last Synced: 2024-05-22T04:26:36.060Z (about 1 month ago)
• Topics: blockchain, debugging, debugging-tool, documentation, ethereum, evm, remix, remix-ide, smart-contracts, solidity, vyper
• Homepage: https://remix-ide.readthedocs.io
• Size: 73 MB
• Stars: 2,234
• Watchers: 115
• Forks: 1,089
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Security: docs/security.md

Lists

• awesome-stars - ethereum/remix-ide - Documentation for Remix IDE (Others)
• best-of-crypto - GitHub
• web3-awesome - Remix IDE文档
• awesome-stars - ethereum/remix-ide - Documentation for Remix IDE (solidity)

README

        
[![Documentation Status](https://readthedocs.org/projects/docs/badge/?version=latest)](https://remix-ide.readthedocs.io/en/latest/index.html)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/ethereum/remix-ide)

# Remix

This repository contain only Remix's official [Read the Docs](https://readthedocs.org/) documentation source code. Documentation is available [here](https://remix-ide.readthedocs.io/en/latest/).

**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](https://github.com/ethereum/remix-project/blob/master/libs/README.md)

![Remix screenshot](remix_screenshot.png)

## 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 feedbacks are our pleasure. Please reach us on [Gitter](https://gitter.im/ethereum/remix) in case of any query.

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.