Skip to content

Commit 8e24cfe

Browse files
committed
README update
1 parent f541447 commit 8e24cfe

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Diff for: README.md

+4
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ yarn build && yarn serve
4141
This will create and serve a production build. This can be used to verify the
4242
expected behaviors in a production environment and view the Google analytics.
4343

44+
# Linking to other pages
45+
46+
We only allow absolute links to other internal docs pages, e.g. `(modules)[/2.0/docs/library/concepts/modules]`. This is to ensure that links work when the site is deployed to s3 which always appends a trailing slash.
47+
4448
# Customizable Values
4549

4650
It's often useful to present the user with the ability to edit a variable inline to documentation. For example, you're about to present a block of code that references an S3 bucket name. Rather than put in a fixed placeholder like <BUCKET_NAME> which the user has to manually edit, you can use our CustomizableValue component. This component will render as a clickable text field which, when clicked, switches to an input. Any inputted characters will be auto-propegated to all other instances of the component that share the same ID. You can use this component both as a React component and inline to MDX code blocks. We have swizzled the CodeBlock components to make this possible.

0 commit comments

Comments
 (0)