Skip to content

Added initial config for docs #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DanielBrierton wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Added initial config for docs #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
70c9fe3
Added initial config for docs
DanielBrierton Sep 3, 2019
128139e
Merge branch 'master' into react-styleguidist
Phidelux Sep 26, 2019
10584b7
Merge remote-tracking branch 'upstream/master' into react-styleguidist
DanielBrierton Oct 15, 2019
08e6a3e
Removed need for Pure components to then be wrapped
DanielBrierton Oct 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,20 @@ Currently you can customize the focus color of components through props, font co

KaiUI uses custom icons provided on the KaiOS developer portal. These are included in the kai-icons font and incorporated as [SASS/CSS classes](https://github.com/AdrianMachado/KaiUI/tree/master/src/kai-font).

## Documentation

Documentation is written using [React Styleguidist](https://react-styleguidist.js.org/). You can run the docs server by running

```
npm run docs
```

You can build the docs for publishing by running

```
npm run docs:build
```

# Contributing

There's much work to be done on building out more UI components, writing tests, and integrating typing (probably using flow).
Expand Down
Loading