From 48d82224ee34fd60ad21ab90a2c38dd4cfb1fdb4 Mon Sep 17 00:00:00 2001 From: Pritesh Nandgaonkar Date: Fri, 16 Feb 2018 07:38:27 -0800 Subject: [PATCH] Add redirect documentation Summary: Add redirect documentation Reviewed By: emilsjolander Differential Revision: D7010032 fbshipit-source-id: fc370bc84e3afa0508ad38f910cf2bc20e991d84 --- .../contents/contributing/writing-documentation.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/website/contents/contributing/writing-documentation.md b/website/contents/contributing/writing-documentation.md index f6709b82..96b6b38a 100644 --- a/website/contents/contributing/writing-documentation.md +++ b/website/contents/contributing/writing-documentation.md @@ -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 ``` + +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 +--- + +```