DaddyFrosty/yoga
1
0
Fork 0
Code Issues 96 Pull Requests 31 Actions Packages Projects Releases 33 Wiki Activity

Add redirect documentation

Browse Source 
Summary: Add redirect documentation

Reviewed By: emilsjolander

Differential Revision: D7010032

fbshipit-source-id: fc370bc84e3afa0508ad38f910cf2bc20e991d84
This commit is contained in:
Pritesh Nandgaonkar
2018-02-16 07:38:27 -08:00
committed by Facebook Github Bot
parent 100afcfdb0
commit 48d82224ee
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
website/contents/contributing/writing-documentation.md
View File

@@ -29,6 +29,8 @@ initialPlayground: eyJ3aWR0aCI6IjYwMCIsImhlaWdodCI6NTAwLCJjaGlsZHJlbiI6W3t9LHt9L
pages with playgrounds and contains the initial playground state.
This base64 string is a reference to the hash (content after #)
of a [playground](/playground) url.
- The `redirect` property allows to redirect to the other page, the path of which is mentioned in the property `path`.
Within the markdown of a documentation page which has an associated
playground you can add controls to let the user play around with the feature
@@ -37,3 +39,14 @@ directly from the documenation page.
```markdown
<controls prop="alignContent"></controls>
```
If you would like to redirect to another page (potentially an external link) the header would look something like this.
```markdown
---
path: "/playground#eyJ3aWR0aCI6IjYwMCIsImhlaWdodCI6NTAwLCJjaGlsZHJlbiI6W3t9LHt9LHt9XX0="
title: "Flex Direction"
redirect: true
---
```