search

mdbootstrap / mdb-react-ui-kit

React 18 & Bootstrap 5 & Material Design 2.0 UI KIT
https://mdbootstrap.com/docs/b5/react/
Other
1.41k stars 264 forks source link

Documentation looks vague #36

Closed johadi closed 6 years ago

johadi commented 6 years ago

Your documentation on installing this package to work with React ( link ) is not appropriate, lacks some info. In the doc, it is said to just install the package and start using it whereas , you need to import the following:

import 'bootstrap/dist/css/bootstrap.css'
import 'mdbreact/dist/css/mdb.css'

You guys should correct this. Also, the installation guide for setting this package with create-react-app is inappropriate; it never works for me. You guys probably want to take a look at the whole installation guide you provided for react as everything looks vague. I had to download the package, check the whole project to get brief understanding of how things work together before I actually made headway on using it. Good job done but please, let the user be pleased by giving them good doc.

smolenski-mikolaj commented 6 years ago

Thanks for Your remarks. We'll update docs with the next release.

FernandoBoza commented 6 years ago

@johadi thank you! I was looking for this everyone

Mikuu commented 6 years ago

@smolenski-mikolaj I'm also got lost about the React version documentation, I searched around your whole site, but haven't found any detailed documentation about the MDB react version usage, e.g. the component API.

Is there any documentation or reference guide about the React version?

smolenski-mikolaj commented 6 years ago

Here's the link to our React docs: https://mdbootstrap.com/react/