ContributingDocs site
Links and escapes
Write each link as an absolute path with no slash at the end. Put braces and angle brackets in code.
See [Deploys](/docs/concepts/deploys).
Run [`ferry deploy`](/docs/reference/cli#ferry-deploy).Links
A link is absolute and has no slash at the end.
| Link to | Form | Example |
|---|---|---|
| A page | The path of the page | /docs/concepts/deploys |
| A CLI command | The anchor #ferry-<command> | /docs/reference/cli#ferry-deploy, #ferry-env-set |
| An API operation | An anchor from its summary | /docs/reference/api/services#scale-a-service |
npm run build fails on a link or an anchor that goes nowhere. See Build and deploy.
Escapes
MDX reads { and < as the start of code. Outside a code block, you have two solutions:
| Solution | Example |
|---|---|
| Write a backslash before the character | \{, \} and \< |
| Put the text in backticks | `<name>` |
A reference such as ${{datastore.NAME.connectionString}} always goes in backticks or in a code block.