Skip to content

Commit 1d7041b

Browse files
authored
Merge pull request #14972 from ethereum/md-syntax-fixes
Md syntax fixes
2 parents 29db01a + d3bf143 commit 1d7041b

File tree

180 files changed

+477
-327
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

180 files changed

+477
-327
lines changed

next.config.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,18 @@ module.exports = (phase, { defaultConfig }) => {
115115
"node_modules/@swc/core-linux-x64-gnu",
116116
"node_modules/@swc/core-linux-x64-musl",
117117
"node_modules/@esbuild/linux-x64",
118+
"src/data",
119+
"public/**/*.jpg",
118120
"public/**/*.png",
121+
"public/**/*.webp",
122+
"public/**/*.svg",
119123
"public/**/*.gif",
120-
"src/data",
124+
"public/**/*.json",
125+
"public/**/*.txt",
126+
"public/**/*.xml",
127+
"public/**/*.pdf",
128+
"public/fonts",
129+
"public/images",
121130
],
122131
},
123132
},

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
},
9191
"devDependencies": {
9292
"@chromatic-com/storybook": "1.5.0",
93-
"@netlify/plugin-nextjs": "^5.8.0",
93+
"@netlify/plugin-nextjs": "^5.10.0",
9494
"@storybook/addon-essentials": "8.1.10",
9595
"@storybook/addon-interactions": "8.1.10",
9696
"@storybook/addon-links": "8.1.10",

public/content/contributing/translation-program/translators-guide/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ The best way to handle links is to copy them directly from the source, either by
122122

123123
![Example of link.png](./example-of-link.png)
124124

125-
Links also appear in the source text in the form of tags (i.e. <0> </0>). If you hover over the tag, the editor will show its full content - sometimes these tags will represent links.
125+
Links also appear in the source text in the form of tags (i.e. \<0> \</0>). If you hover over the tag, the editor will show its full content - sometimes these tags will represent links.
126126

127127
It is very important to copy the links from the source and not change their order.
128128

@@ -160,7 +160,7 @@ nonce - _Non-translatable text_
160160

161161
The source text also contains shortened tags, which only contain numbers, meaning that their function is not immediately obvious. You can hover over these tags to see exactly which function they serve.
162162

163-
In the example below, you can see that hovering over the <0> tag shows that it represents `<code>` and contains a code snippet, therefore the content inside these tags should not be translated.
163+
In the example below, you can see that hovering over the \<0> tag shows that it represents `<code>` and contains a code snippet, therefore the content inside these tags should not be translated.
164164

165165
![Example of ambiguous tags.png](./example-of-ambiguous-tags.png)
166166

public/content/developers/docs/networking-layer/portal-network/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The benefits of this network design are:
5555
- reduce dependence on centralized providers
5656
- Reduce Internet bandwidth usage
5757
- Minimized or zero syncing
58-
- Accessible to resource-constrained devices (<1 GB RAM, <100 MB disk space, 1 CPU)
58+
- Accessible to resource-constrained devices (\<1 GB RAM, \<100 MB disk space, 1 CPU)
5959

6060
The diagram below shows the functions of existing clients that can be delivered by the Portal Network, enabling users to access these functions on very low-resource devices.
6161

public/content/developers/docs/smart-contracts/formal-verification/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Low-level formal specifications can be given as either Hoare-style properties or
7070

7171
### Hoare-style properties {#hoare-style-properties}
7272

73-
[Hoare Logic](https://en.wikipedia.org/wiki/Hoare_logic) provides a set of formal rules for reasoning about the correctness of programs, including smart contracts. A Hoare-style property is represented by a Hoare triple {_P_}_c_{_Q_}, where _c_ is a program and _P_ and _Q_ are predicates on the state of the _c_ (i.e., the program), formally described as _preconditions_ and _postconditions_, respectively.
73+
[Hoare Logic](https://en.wikipedia.org/wiki/Hoare_logic) provides a set of formal rules for reasoning about the correctness of programs, including smart contracts. A Hoare-style property is represented by a Hoare triple \{_P_}_c_\{_Q_}, where _c_ is a program and _P_ and _Q_ are predicates on the state of the _c_ (i.e., the program), formally described as _preconditions_ and _postconditions_, respectively.
7474

7575
A precondition is a predicate describing the conditions required for the correct execution of a function; users calling into the contract must satisfy this requirement. A postcondition is a predicate describing the condition that a function establishes if correctly executed; users can expect this condition to be true after calling into the function. An _invariant_ in Hoare logic is a predicate that is preserved by execution of a function (i.e., it doesn't change).
7676

public/content/developers/tutorials/creating-a-wagmi-ui-for-your-contract/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,7 @@ These days there are a lot of [L2 scaling solution](https://ethereum.org/en/laye
561561
}
562562
```
563563

564-
# Conclusion {#conclusion}
564+
## Conclusion {#conclusion}
565565

566566
Of course, you don't really care about providing a user interface for `Greeter`. You want to create a user interface for your own contracts. To create your own application, run these steps:
567567

public/content/developers/tutorials/erc-721-vyper-annotated-code/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -696,7 +696,7 @@ code clearer and therefore easier to secure. So to create your own Vyper ERC-721
696696
contract](https://github.com/vyperlang/vyper/blob/master/examples/tokens/ERC721.vy) and modify it
697697
to implement the business logic you want.
698698

699-
# Conclusion {#conclusion}
699+
## Conclusion {#conclusion}
700700

701701
For review, here are some of the most important ideas in this contract:
702702

public/content/developers/tutorials/erc20-annotated-code/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,7 @@ the way normal addition does.
681681

682682
These are the four functions that do the actual work: `_transfer`, `_mint`, `_burn`, and `_approve`.
683683

684-
#### The \_transfer function {#\_transfer}
684+
#### The _transfer function {#_transfer}
685685

686686
```solidity
687687
/**
@@ -757,7 +757,7 @@ is atomic, nothing can happen in the middle of it.
757757
Finally, emit a `Transfer` event. Events are not accessible to smart contracts, but code running outside the blockchain
758758
can listen for events and react to them. For example, a wallet can keep track of when the owner gets more tokens.
759759

760-
#### The \_mint and \_burn functions {#\_mint-and-\_burn}
760+
#### The _mint and _burn functions {#_mint-and-_burn}
761761

762762
These two functions (`_mint` and `_burn`) modify the total supply of tokens.
763763
They are internal and there is no function that calls them in this contract,
@@ -819,7 +819,7 @@ Make sure to update `_totalSupply` when the total number of tokens changes.
819819

820820
The `_burn` function is almost identical to `_mint`, except it goes in the other direction.
821821

822-
#### The \_approve function {#\_approve}
822+
#### The _approve function {#_approve}
823823

824824
This is the function that actually specifies allowances. Note that it allows an owner to specify
825825
an allowance that is higher than the owner's current balance. This is OK because the balance is
@@ -904,7 +904,7 @@ are not designed to handle it.
904904
This is the hook function to be called during transfers. It is empty here, but if you need
905905
it to do something you just override it.
906906

907-
# Conclusion {#conclusion}
907+
## Conclusion {#conclusion}
908908

909909
For review, here are some of the most important ideas in this contract (in my opinion, yours is likely to vary):
910910

public/content/developers/tutorials/hello-world-smart-contract-fullstack/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ In your project directory type:
263263
npm install --save-dev @nomiclabs/hardhat-ethers "ethers@^5.0.0"
264264
```
265265

266-
### Step 13: Update hardhat.config.js {#step-13-update-hardhat.configjs}
266+
### Step 13: Update hardhat.config.js {#step-13-update-hardhat-configjs}
267267

268268
We’ve added several dependencies and plugins so far, now we need to update `hardhat.config.js` so that our project knows about all of them.
269269

public/content/developers/tutorials/how-to-mint-an-nft/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ published: 2021-04-22
1212
[3LAU](https://www.forbes.com/sites/abrambrown/2021/03/03/3lau-nft-nonfungible-tokens-justin-blau/?sh=5f72ef64643b): $11 Million
1313
[Grimes](https://www.theguardian.com/music/2021/mar/02/grimes-sells-digital-art-collection-non-fungible-tokens): $6 Million
1414

15-
All of them minted their NFTs using Alchemy’s powerful API. In this tutorial, we’ll teach you how to do the same in <10 minutes.
15+
All of them minted their NFTs using Alchemy’s powerful API. In this tutorial, we’ll teach you how to do the same in \<10 minutes.
1616

1717
“Minting an NFT” is the act of publishing a unique instance of your ERC-721 token on the blockchain. Using our smart contract from [Part 1 of this NFT tutorial series](/developers/tutorials/how-to-write-and-deploy-an-nft/), let’s flex our Web3 skills and mint an NFT. At the end of this tutorial, you’ll be able to mint as many NFTs as your heart (and wallet) desires!
1818

0 commit comments

Comments
 (0)