Documentation pages are generated from Markdown files in
The files are organized in 4 sections/folders (getting-started, properties,
examples, contributing) which are dynamically listed on the docs overview page.
The Markdown files should contain a header with metadata.
--- path: "docs/flexDirection" title: "Flex Direction" hasPlayground: true initialPlayground: eyJ3aWR0aCI6IjYwMCIsImhlaWdodCI6NTAwLCJjaGlsZHJlbiI6W3t9LHt9LHt9XX0= ---
pathindicates the URL path this page will be available at.
titleis used as the page's HTML-title and when referencing the file from the documentation overview.
hasPlaygroundproperty indicates whether this documentation has an associated playground to test out the documented feature.
initialPlaygroundproperty is only relevant for documentation pages with playgrounds and contains the initial playground state. This base64 string is a reference to the hash (content after #) of a playground url.
redirectproperty allows to redirect to the other page, the path of which is mentioned in the property
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 directly from the documenation page.
If you would like to redirect to another page (potentially an external link) the header would look something like this.
--- path: "/playground?eyJ3aWR0aCI6IjYwMCIsImhlaWdodCI6NTAwLCJjaGlsZHJlbiI6W3t9LHt9LHt9XX0=" title: "Flex Direction" redirect: true ---