@stoplight/elements

Elements

• Explore the components: Storybook
• View the changelog: Releases

Features

TBD

Installation

Supported in modern browsers and node.

# latest stable
yarn add @stoplight/elements

Usage

import { Page, Provider, TableOfContents } from '@stoplight/elements';

<Provider>
  <div className="flex">
    <TableOfContents srn="gh/stoplightio/elements" />

    <Page className="flex-1" srn="gh/stoplightio/elements/docs/README.md" />
  </div>
</Provider>;

Contributing

1. Clone repo.
2. Create / checkout feature/{name}, chore/{name}, or fix/{name} branch.
3. Install deps: yarn.
4. Make your changes.
5. Run tests: yarn test.prod.
6. Stage relevant files to git.
7. Commit: yarn commit. NOTE: Commits that don't follow the conventional format will be rejected. yarn commit creates this format for you, or you can put it together manually and then do a regular git commit.
8. Push: git push.
9. Open PR targeting the master branch.