You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/FAQ.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@
18
18
19
19
`Ctrl+S`: Compiles the active Solidity file
20
20
21
-
`Ctrl+Shift+S`: Compiles a Solidity file and runs a script when the script is displayed in the editor.<br>(go [here](running_js_scripts.html#compile-a-contract-and-run-a-script-on-the-fly) for more info about this functionality)
21
+
`Ctrl+Shift+S`: Compiles a Solidity file and runs a script when the script is displayed in the editor.<br>(go {ref}`here <running_js_scripts:compile a contractandrun a script in one click>` for more info about this functionality)
22
22
23
23
`Ctrl+Shift+F` : Opens the File Explorer
24
24
@@ -108,7 +108,7 @@ The input of initPeepToPeeps takes a struct. If you input
108
108
109
109
**Q:** Where do plugin developers go with their questions?
110
110
111
-
**A:** First, join our [Discord server](https://discord.gg/zUNteAzJs3) and then go to the development-plugin channel.
111
+
**A:** First, join our [Discord server](https://discord.com/invite/zUNteAzJs3) and then go to the development-plugin channel.
Copy file name to clipboardExpand all lines: docs/compile.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,14 +60,14 @@ When you publish your metadata to IPFS and deploy your code to the mainnet or a
60
60
61
61
### Compile and Run script
62
62
63
-
The Compile and Run script button (**E. in fig. 1**) is for compiling and then immediately running a script. It's a time saver so that you can write some code, automatically run script that sets state of the contract - thus allowing you to quickly understand how the code is working. ([more about Compile & Run](running_js_scripts.html?#compile-a-contract-and-run-a-script-on-the-fly))
63
+
The Compile and Run script button (**E. in fig. 1**) is for compiling and then immediately running a script. It's a time saver so that you can write some code, automatically run script that sets state of the contract - thus allowing you to quickly understand how the code is working. Learn {ref}`more about Compile and Run <running_js_scripts:compile a contractandrun a script in one click>`.
64
64
65
65
### Compilation Errors and Warning
66
66
67
67
Compilation Errors and Warning are displayed below the contract section.
68
68
At each compilation, the static analysis tab builds a report.
69
69
70
-
It is important to address reported issues even if the compiler doesn't complain. ([more about static analysis](static_analysis.html))
70
+
It is important to address reported issues even if the compiler doesn't complain. ({doc}`more about static analysis </static_analysis>`)
71
71
72
72
## Advanced Compiler Configurations
73
73
@@ -93,7 +93,7 @@ To see the name of the hard fork used in the current compilation, click the "Com
93
93
94
94
According to the Solidity Docs, "the optimizer tries to simplify complicated expressions, which reduces both code size and execution cost, i.e., it can reduce gas needed for contract deployment as well as for external calls made to the contract."
95
95
96
-
For recent versions of Solidity, it is [recommended to enable optimization](https://blog.soliditylang.org/2020/11/04/solidity-ama-1-recap/#why-do-you-think-people-are-generally-suspicious-of-the-optimizer-and-are-they-right-to-be).
96
+
For recent versions of Solidity, it is [recommended to enable optimization](https://soliditylang.org/blog/2020/11/04/solidity-ama-1-recap/#:~:text=Why%20do%20you%20think%20people%20are%20generally%20suspicious%20of%20the%20optimizer%2C%20and%20are%20they%20right%20to%20be%3F).
97
97
98
98
To learn more about optimization, (**Q. in the fig 2**) visit the [Solidity docs on the optimizer](https://docs.soliditylang.org/en/latest/internals/optimizer.html).
Copy file name to clipboardExpand all lines: docs/create_deploy.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Let's go through a basic workflow:
14
14
15
15
In the File Explorer, create a new file by clicking on the new file icon, and name it. The `.sol` is default extension in Remix, if a file is named without an extension, `.sol` will appended.
16
16
17
-
**NOTE:** For information about templates or workspaces, see the [File Explorer docs](file_explorer.html).
17
+
**NOTE:** For information about templates or workspaces, see the {doc}`File Explorer docs </file_explorer>`.
18
18
19
19
In the editor, paste in the following contract into the empty file:
20
20
@@ -53,13 +53,14 @@ When pasting in code, make sure you understand it before deploying or interactin
53
53
With the contract above as the active tab in the Editor, compile the contract.
54
54
A quick way to compile is to hit **ctrl + s**. You can also compile by going to the Solidity Compiler and clicking the compile button, or by right clicking a file in the File Explorer, or by clicking the play button at the top of the Editor.
55
55
56
-
**For More Info** see the docs on the [Solidity Compiler](compile.html).
56
+
**For More Info** see the docs on the {doc}`Solidity Compiler </compile>`.
57
57
58
58
## Deploy the contract
59
59
60
60
Go to the **Deploy & Run Transactions** plugin.
61
61
62
-
At the top of this plugin is the Environment selectbox. Here you can choose where you want to deploy your contract. There are many choices. For more info about these options see [this section](run.html#environment) of the docs.
62
+
63
+
At the top of this plugin is the Environment selectbox. Here you can choose where you want to deploy your contract. There are many choices. For more info about these options see {ref}`this section <run:environment>` of the docs.
Copy file name to clipboardExpand all lines: docs/debugger.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,15 +12,15 @@ To start a debugging session either:
12
12
13
13
The debugger will highlight the relevant code in the Editor. If you want to go back to editing the code without the Debugger's highlights, then click the **Stop Debugging** button.
14
14
15
-
To learn more about how to use this tool go to the [Debugging Transactions](tutorial_debug.html) page.
15
+
To learn more about how to use this tool go to the {doc}`Debugging Transactions </tutorial_debug>` page.
16
16
17
17
This page will go over the Debugger's _Use generated sources_ option, its navigation and its panels.
18
18
19
19

20
20
21
21
## Use generated sources
22
22
23
-
This option is available for contracts using Solidity 0.7.2 or greater. See the solidity blog for more details about [generated sources](https://blog.soliditylang.org/2020/09/28/solidity-0.7.2-release-announcement/#notable-new-features).
23
+
This option is available for contracts using Solidity 0.7.2 or greater. See the solidity blog for more details about [generated sources](https://soliditylang.org/blog/2020/09/28/solidity-0.7.2-release-announcement/#:~:text=Notable%20New%20Features).
24
24
25
25
Using **generated sources** will make it easier to audit your contracts. When the option is checked, you can step into those compiler outputs — while debugging.
26
26
@@ -164,4 +164,4 @@ Breakpoints can be placed in the gutter of the Editor to pause the debugger.
164
164
165
165
The debugger's granular information gives users detailed information about what is happening in a transaction - so not only is the debugger good for debugging, it is also an excellent teaching tool.
166
166
167
-
To learn about using the debugger, go to [Debugging Transactions](tutorial_debug.html).
167
+
To learn about using the debugger, go to {doc}`Debugging Transactions </tutorial_debug>`.
Copy file name to clipboardExpand all lines: docs/file_explorer.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ There are two ways you can save the files you create and use on Remix to your ha
28
28
29
29
#### Remixd
30
30
31
-
Remixd is an NPM package that allows you to share a specified folder on your computer with Remix IDE. Thus, your files are saved on IndexedDB and on the specified folder. Learn more about Remixd on our [Remixd guide](remixd.html).
31
+
Remixd is an NPM package that allows you to share a specified folder on your computer with Remix IDE. Thus, your files are saved on IndexedDB and on the specified folder. Learn more about Remixd on our {doc}`Remixd guide </remixd>`.
Copy file name to clipboardExpand all lines: docs/git.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,16 +16,16 @@ Alternatively, you can add username and email to the Github section of the Git p
16
16
17
17
### Initializing Git in a Workspace
18
18
19
-
For information about initializing a workspace, see the section about initializing Git on the [Remix Workspaces](/workspaces/#initializing-a-workspace-with-git) page.
19
+
For information about initializing a workspace, see the section about initializing Git on the {ref}`Remix Workspaces <workspaces:initializing a workspacewithgit>` page.
20
20
21
21
### Cloning an existing repository into Remix
22
22
23
23
You can clone an existing repository from GitHub into Remix using "**CLONE**" accordion item in the Git plugin. You can clone a repository by loading it from GitHub using the "**Load from GitHub**" button and selecting one from your list of public repositories.
24
24
25
-
Alternatively, you can clone a repository by providing its URL in the "**CLONE FROM URL**" text box. When you clone a repository, Remix initializes it as a separate Workspace. See [Remix Workspaces](/workspaces) to learn more about Workspaces.
25
+
Alternatively, you can clone a repository by providing its URL in the "**CLONE FROM URL**" text box. When you clone a repository, Remix initializes it as a separate Workspace. See {doc}`Remix Workspaces <workspaces>` to learn more about Workspaces.
26
26
27
27
```{note}
28
-
Remix stores your files in the browser and browser storage is limited. Cloning a repository that is too large will cause the Remix IDE. This is why you have to manually specify the depth and branches you want to clone. If you are using [Remixd](/remixd) you don't have to worry about cloning large repositories.
28
+
Remix stores your files in the browser and browser storage is limited. Cloning a repository that is too large will cause the Remix IDE. This is why you have to manually specify the depth and branches you want to clone. If you are using {doc}`Remixd </remixd>` you don't have to worry about cloning large repositories.
Copy file name to clipboardExpand all lines: docs/hardhat.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,9 @@ _(Supported since Remix IDE v0.12.0 and Remixd v0.3.6)_
4
4
5
5
## Remixd and Hardhat
6
6
7
-
**Note:** If you have not used `remixd` before, read more about it [here](./remixd.html)
7
+
```{note}
8
+
If you have not used `remixd` before, read more about it {doc}`in the Remixd documentation </remixd>`.
9
+
```
8
10
9
11
If `remixd` is running locally on your device and shared folder is a **Hardhat project**, an additional websocket plugin will be listening on port `65522`. According to its documentation,
10
12
@@ -30,7 +32,7 @@ To use Hardhat compilation with Remix IDE efficiently:
30
32
31
33
### How to use
32
34
33
-
If a hardhat project is shared through remixd and `localhost` workspace is loaded in Remix IDE, there will be an extra checkbox shown in `Solidity Compiler` plugin with the label `Enable Hardhat Compilation`.
35
+
If a hardhat project is shared through Remixd and `localhost` workspace is loaded in Remix IDE, there will be an extra checkbox shown in `Solidity Compiler` plugin with the label `Enable Hardhat Compilation`.
### Importing a file from your computer's filesystem
65
65
66
-
This method uses **remixd** - the remix daemon. Please go to the [remixd docs](remixd.html) for instructions about how to bridge the divide between the browser and your computer's filesystem.
66
+
This method uses **remixd** - the remix daemon. Please go to the {doc}`remixd docs </remixd>` for instructions about how to bridge the divide between the browser and your computer's filesystem.
0 commit comments