This repository holds the official Read the Docs source for Remix IDE, the open source web and desktop environment for writing, compiling, deploying and debugging Ethereum smart contracts, and it is written for the Solidity and Vyper developers who read that documentation, the educators who teach with it, and the contributors and translators who maintain it.

What it is

Remix Docs is the documentation codebase of the Remix Project, a platform for development tools built on a plugin architecture that encompasses the Remix Plugin Engine, the Remix Libraries and Remix IDE itself. This repository contains only the documentation source; the published output is the Remix IDE documentation site at https://remix-ide.readthedocs.io/en/latest/. The site is generated with Sphinx using the Read the Docs theme as a base, then customised through CSS overrides and JavaScript, with the asset lists declared in conf.py under html_js_files and html_css_files. The README also maps the sibling codebases: the IDE itself lives in the remix-project repository and runs at https://app.remix.live, while the project's about page lives in remix-website at https://remix.live.

The concrete problem it solves is documentation drift across a plugin-based toolchain. Remix IDE is used across the entire journey of contract development in Solidity, and its built-in plugins sit on top of the Remix Libraries, which handle core operations such as compiling contracts and interacting with them. Without a single maintained source, that material would be scattered across the IDE repositories, plugin repositories and the interface itself. This repository replaces that fragmentation with one internationalised, versioned documentation source covering the EVM toolchain, contract debugging, and the plugins that wrap it.

Key capabilities

• Documents the full Remix IDE contract development journey for Solidity, and serves as a playground reference for learning and teaching Ethereum.
• Documents the Remix Libraries that the IDE's built-in plugins are built on, including compiling smart contracts and interacting with them.
• Builds locally with Sphinx: clone the repository, cd into the docs folder and run make run.
• Is internationalised, with .po and .pot files managed on Crowdin rather than edited in the repository; translation projects are remix-translation for the documentation and remix-ui for the Remix interface.
• Overrides the base Read the Docs theme through declared JavaScript files js/constants.js, js/utils.js, js/loaders.js and js/initialize.js, and CSS files css/fonts.css, css/tokens.css and css/custom.css.
• Splits theming logic by role under docs/_static/: constants, shared utilities, loaders, and initialize.js, which declares the order of loaders.js functions to run on onDOMContentLoaded.
• Covers the Ethereum, EVM, blockchain, smart contract and debugging topics that the IDE's users search for.

Who uses it and how

• Solidity and Vyper developers consulting reference material while compiling, deploying and debugging contracts in the browser IDE at https://app.remix.live or the desktop build.
• Instructors and students using Remix as a teaching and learning environment for Ethereum, where the documentation supplies the explanatory layer the interface does not.
• Documentation contributors filing issues, suggestions, queries and feedback, and coordinating through the project's Discord server.
• Translators working through the Crowdin projects rather than editing .po or .pot files directly.
• Frontend and theming contributors editing the CSS tokens, custom stylesheet and loader scripts under docs/_static/. The repository carries 2,350 stars, 961 forks and 23 open issues.

Getting started

Clone the repository with git clone https://github.com/remix-project-org/remix-ide, change into the docs folder inside the clone, and run make run to build and serve the documentation locally. Readers who want the IDE rather than its documentation should go to https://app.remix.live or the remix-desktop repository.

How it compares

No list of paid products replaced by this project is provided in the facts. Among the tools the facts do name, Sphinx and the Read the Docs theme form the base layer, and this repository is a project-specific documentation source that customises that base with CSS overrides and loader scripts rather than a general-purpose documentation framework in its own right. Its scope is deliberately narrow: one project's documentation, published to one Read the Docs site.

When to use it — and when not to

A self-hoster operates a Sphinx build toolchain and the Read the Docs theme, and needs a Python environment capable of running the make run target; translation state cannot be edited locally, because .po and .pot files are owned by Crowdin. Anyone seeking the Remix IDE application code, plugin implementations or Remix Libraries should not start here, since this repository contains documentation source only. The README is sparse about the IDE's own features and describes mainly documentation setup, theming files and contribution routes, so readers wanting product detail must follow the links it provides to the other Remix Project repositories. The licence is Apache-2.0.

git clone https://github.com/remix-project-org/remix-ide

make run

html_js_files = [
    "js/constants.js",
    "js/utils.js",
    "js/loaders.js",
    "js/initialize.js"
]

html_css_files = ["css/fonts.css", "css/tokens.css", "css/custom.css"]