Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.63 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.63 KB

Amplify UI Documentation

These docs are published at https://docs.amplify.aws/ui and powered by the following technologies:

Contributing

Getting Started

  1. Navigate to the root of your local clone of aws-amplify/amplify-ui
  2. Run yarn setup
  3. Run yarn docs dev
  4. Open http://localhost:5000/
  5. Optional: To build the flutter authenticator sample, install flutter and then run yarn flutter:build. This will build the flutter authenticator one time. It will not watch for changes.

Creating a Page

Page paths mirror their URLs. For example, /ui/components/authenticator is located at /src/pages/ui/components/authenticator/index.page.mdx.

Component & primitive pages are located at src/pages/ui/components/*/index.page.mdx and src/pages/ui/primitives/*/index.page.mdx, respectively.

At a minimum, all .page.mdx files require the following basic frontmatter:

---
title: My Title
---

Content goes here...

My Title will show up in the sidebar navigation, while content will be statically generated & indexed.

Note that dynamic content (e.g. import Page from "${slug}.mdx") is not statically generated and harder to index. Because of this, ensure indexable content always exists and only supplemental content & demos are loaded asynchronously.

Pages must end with .page.(mdx|tsx) to differentiate them supplemental .mdx fragments or .tsx utilities.