Doctorlink Design System
React components that implement DoctorLink's Design System
Installation
DoctorLink Design System is available as an npm package.
npm install doctorlinkds
Usage
Here is a quick example to get you started, it's all you need:
import React from 'react';import render from 'react-dom';import Button from 'doctorlinkds/Button'; { return <Button ="raised" ="primary"> Hello World </Button> ;} ;
Yes, it's really all you need to get started as you can see in this live and interactive demo:
Bite the bullet and go for v1-beta.
Questions
For how-to questions and other non-issues, please use StackOverflow instead of Github issues. There is a StackOverflow tag called "material-ui" that you can use to tag your questions.
Examples
Are you looking for an example project to get started? We host some.
Documentation
Check out our documentation website.
Contributing
We'd greatly appreciate any contribution you make. :)
Changelog
Recently Updated? Please read the changelog.
Roadmap
The future plans and high priority features and enhancements can be found in the ROADMAP.md file.
Thanks
Thank you to BrowserStack for providing the infrastructure that allows us to test in real browsers.
License
This project is licensed under the terms of the MIT license.
DoctorLink
package.json commands
Command | Description |
---|---|
docs:dev |
runs docs in dev mode |
docs:api |
builds api core and api lab |
docs:api:core |
builds all components in ./src |
docs:api:lab |
builds all components in ./packages/material-ui-lab/src |
docs:icons |
builds logo: ./static/logo.png |
docs:build |
production build of docs |
docs:start |
runs next start |
To do
- Remove Material UI string references
- Update
./static/logo.png
and build icons - Update icons in components