mui icon indicating copy to clipboard operation
mui copied to clipboard

How we can update the muicss docs?

Open amerllica opened this issue 4 years ago • 3 comments

I wanna update the muicss docs for implementing CSS of muicss in ReactJS. how we can help with docs?

amerllica avatar May 26 '20 18:05 amerllica

That'd be great! If you're referring to the documentation on the website (https://www.muicss.com) then the easiest way to update it would be to tell me what you want to do and then I can update it for you.

amorey avatar May 27 '20 06:05 amorey

Actually, it is better the muicss.com website be on GitHub and some eager developers like me contribute the docs. it makes the muicss as an advanced library.

let's back to the issue, on the top of this page of docs. there is a simple way to add CSS of muicss to the project. using the following link tag:

<link href="//cdn.muicss.com/mui-0.10.2/css/mui.min.css" rel="stylesheet" type="text/css" media="screen" />

It's not a good way because if next developers update the muicss and forgot to update this part of HTML then maybe it causes to bad bugs.

There is a better way to import CSS of muicss to any type of projects and I describe it on this SO question:

/* root file of styles.scss */

:global {
  @import 'node_modules/muicss/lib/sass/mui';
}

It's a better solution to adding CSS of muicss and when next developers update the package then they will have new CSS of muicss.

Also, The docs don't have any guide about CSS, I seek whole the website, nowhere isn't told by installing the muicss components you just have the Logic+HTML and for styles, you should import CSS of muicss.

Still, I believe the website should be on GitHub and eager developers make it better. this way is not very optimal

amerllica avatar May 27 '20 07:05 amerllica

Having the static documentation on github would be ideal but right now it's a dynamic website so it wouldn't be easy to make it editable on github.

Regarding your suggestion, using the pre-packaged CSS file is useful for a quickstart so I wouldn't want to eliminate that as an option. Otherwise you have to have SASS installed and a functioning build environment.

Currently this is the documentation on how to custimize the CSS for a site: https://www.muicss.com/docs/v1/css-js/customization

Let me know if you have any suggestions.

amorey avatar Jun 02 '20 09:06 amorey