Hey DevRels!
So much of your job is to get your users to try something out. Whether it be some code or a technique, everyone knows that Remix is THE no-setup toolset—but that is just the start!
This article will show you how to improve your docs, tutorials, demos and outreach for easy compatibility with, or within, Remix.
Deep Linking from your Docs into Remix
Many projects have an Open in Remix button in their docs. A link to Remix with URL parameters can load a file, a folder, configure plugins and tutorials, and more!
Load a file via https into Remix
Use the ‘url’ parameter:
https://remix.ethereum.org/#url=https://github.com/remix-project-org/remix-project/blob/master/apps/remix-ide/contracts/app/solidity/mode.solLoad a folder from GitHub into Remix
Use the ‘ghfolder’ parameter:
https://remix.ethereum.org/?#ghfolder=https://github.com/samnang/flash-loan-examples/tree/main/contracts/basicLoad a GIST
Use the ‘gist’ parameter:
https://remix.ethereum.org/?#gist=0fe90e825327ef313c88aedfe66ec142Load a base64 encoded file
Use the ‘code’ parameter:
https://remix.ethereum.org/?#code=Ly8gU1BEWC1MaWNlbnNlLUlkZW50aWZpZXI6IEdQTC0zLjAKCnByYWdtYSBzb2xpZGl0eSA+PTAuOC4yIDwwLjkuMDsKCmNvbnRyYWN0IFNwcmluZyB7CgogICAgc3RyaW5nIHB1YmxpYyBmaW5hbGx5OwoKICAgIGZ1bmN0aW9uIGFycml2ZWQoKSBwdWJsaWMgdmlldyByZXR1cm5zIChzdHJpbmcgbWVtb3J5KXsKICAgICAgICByZXR1cm4gZmluYWxseTsKICAgIH0KfQ==This is used in the OpenZeppelin Wizard’s Open in Remix button.
Activate a list of plugins with ‘activate’
The given list will be activated and the last one will be loaded into the Side Panel.
activate is the key.
https://remix.ethereum.org/?#activate=solidityUnitTesting,LearnEthActivate a plugin and pass a command into the plugin’s API with ‘call’
The following URL will activate a list of plugins and then will call LearnEth’s (the tutorial plugin) API to tell it to start a specific tutorial.
https://remix.ethereum.org/?#activate=solidityUnitTesting,LearnEth&call=LearnEth//startTutorial//remix-project-org/remix-workshops//master//proxycontractThe API’s input parameters are separated by //
Read more about Remix with URL Parameters
Check the Remix Docs about Remix with URL parameters for the complete list of options.
Get your Tutorials into Remix: LearnEth
LearnEth is a tutorial platform right inside of Remix. The great thing about using LearnEth tutorials is that it’s embedded within Remix—all the development tools are right there! The Sandbox is set!
Check the current list of LearnEth tutorials in Remix:
https://remix.ethereum.org/?#activate=solidityUnitTesting,LearnEthAdapt your current tutorials for use in LearnEth
Instructions in LearnEth are written in Markdown. There can be example files that load in the Editor. And, there can be test files to check a student’s work.
By default, LearnEth loads tutorials from the Remix Workshops repo.
Checkout the structure of the Solidity Beginner Course, to understand what is involved in writing your own tutorials.
Here’s the Remix URL that will load the Solidity Beginner Course:
https://remix.ethereum.org/?#activate=solidityUnitTesting,solidity,LearnEth&call=LearnEth//startTutorial//remix-project-org/remix-workshops//master//soliditybeginnerNote: in the above URL, I’ve added the solidityUnitTesting plugin to the list of plugins to activate.
Tutorial’s Structure in LearnEth
Tutorial chapters are organized in the config.yml file, and all the chapters are each placed in their own folder. Those folders contain Markdown files with instructions, example files, and test files.
Here is the LearnEth documentation site with comprehensive info on writing your own tutorials.
After building your tutorial, make a PR to submit your tutorial to our Repo, and ping us for review.
LearnEth from your own repo
LearnEth can load tutorials from other repos as well. So, you can create your own repo that follows the LearnEth spec and then direct your users to load that repo.
To load another repo, click on the Import another tutorial repo, and open Select a repo.
If you make your own repo, you can direct your users to a URL that will open a tutorial from your repo in Remix.
With LearnEth you can get in-depth educational content to your community.
Remix Desktop for Coding Demos
No WiFi No Problem
How many times have you tried to perform a live demo that totally failed because of a bad internet connection? Remix now has a Desktop version, so you can work and demo offline!
Remix Desktop is an Electron version of Remix available in Windows, MacOS, and Linux. You can download it here: https://github.com/remix-project-org/remix-desktop
Templates for your Project inside of Remix
Remix’s Template Explorer
Remix Template Explorer has a lot of files and scripts for many projects. It’s a great way to get developers to start playing with your code.
To get to the Template Explorer, click the Create Workspace button:
Then, you’ll get the list of templates.
Get in touch to add your project’s content by clicking on the form on the contact page of our info site: https://remix.live/contact
Plugins
Get your project’s functionality in Remix with a plugin. Plugins come in two flavors:
1. Side panel plugins and 2. Main panel plugins.
For more information about integrations and plugin development, get in touch with us! You can email us at support@remixlabs.live, or drop a note on the form on the contact page of our info site: https://remix.live/contact
Access to Scripts for your Project
Have you tried automating Remix by running TS/JS scripts? We have a several different configurations of dependencies available for scripts to load.
When a TS/JS file is the active file in the Editor, you’ll get a button to run the script and a caret for more options. Clicking the caret will show the current choices.
If you click the Open script configuration option, the panel showing the dependencies available for each configuration will display.
If you don’t see the dependencies you’d like for your project, get in touch!
Forking your Chain
Have your users fork your chain to experiment further!
Easily configuring your chain in Remix
Remix has a link to chainlist.org to easily get the browser wallet configured to your chain!
Get that “Open in Remix Button” into your docs!
Its so effective and easy!
Remix is here to help
Outreach to your devs and potential devs is all about getting them the best info and tools as easily as possible.
From links to Remix with URL parameters to using Remix Online and Remix Desktop for your demos, to getting your tutorials into LearnEth, or developing Remix plugins, Remix can really help push your DevRel efforts.
Email us at support@remixlabs.live or drop a note on the form on the contact page of our info site: https://remix.live/contact