Skip to content

Latest commit

 

History

History

site

Run the site for development: yarn dev (in the site directory)

Preview the production build of the site: yarn build && yarn start

Docs

All of the docs live in the docs in the root of this repository. They are in Markdown and they should include the following frontmatter at the top of each file that specifies the title for the page.

---
title: 'Some Title'
---

Package READMEs

Links in package READMEs should go to https://emotion.sh/docs/{docName} so that clicking the link on npmjs.com brings you to the Emotion website.

Code Blocks

When the langauge is jsx and the code block has a // @live comment, it will have a preview next to it. Most of the Emotion packages can be imported and there is a render function that accepts a react element and will render into the preview next to it.

\`\`\`jsx
// @live

render('some react element')
\`\`\`