Skip to content
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.

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

[docs] Format english markdown files #21463

Merged
merged 5 commits into from Jun 17, 2020
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1,312 changes: 876 additions & 436 deletions CHANGELOG.md

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions CODE_OF_CONDUCT.md
@@ -1,9 +1,11 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language
Expand All @@ -21,19 +23,23 @@ Examples of unacceptable behavior by participants include:
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at conduct@material-ui.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

Expand Down
9 changes: 5 additions & 4 deletions README.md
Expand Up @@ -20,7 +20,7 @@
[![PeerDependencies](https://david-dm.org/mui-org/material-ui/master/peer-status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/master?type=peer&path=packages/material-ui)
[![Dependencies](https://david-dm.org/mui-org/material-ui/master/status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/master?path=packages/material-ui)
[![DevDependencies](https://david-dm.org/mui-org/material-ui/master/dev-status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/master?type=dev)
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/mui-org/material-ui.svg)](https://isitmaintained.com/project/mui-org/material-ui "Average time to resolve an issue")
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/mui-org/material-ui.svg)](https://isitmaintained.com/project/mui-org/material-ui 'Average time to resolve an issue')
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/material-ui-docs/localized.svg?cache=v1)](https://translate.material-ui.com/project/material-ui-docs)

</div>
Expand All @@ -30,6 +30,7 @@
Material-UI is available as an [npm package](https://www.npmjs.com/package/@material-ui/core).

**[Stable channel v4](https://material-ui.com/)**

```sh
// with npm
npm install @material-ui/core
Expand All @@ -52,7 +53,7 @@ Please note that `@next` will only point to pre-releases; to get the latest stab
<a data-ga-event-category="sponsor" data-ga-event-action="logo" data-ga-event-label="sencha" href="https://www.sencha.com/products/extreact/extreact-for-material-ui/?utm_source=materialui&utm_medium=referral&utm_content=product-200429-extreactmaterialui" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img height="128" width="128" src="https://material-ui.com/static/in-house/sencha-256x256.png" alt="sencha" title="UI Components for Productive Dev Teams" loading="lazy" /></a>
</p>

Diamond Sponsors are those who have pledged $1,500/month or more to Material-UI.
Diamond Sponsors are those who have pledged \$1,500/month or more to Material-UI.

### Gold 🏆

Expand All @@ -69,7 +70,7 @@ via [OpenCollective](https://opencollective.com/material-ui)
<a data-ga-event-category="sponsor" data-ga-event-action="logo" data-ga-event-label="callemall" href="https://www.call-em-all.com" rel="noopener sponsored" target="_blank" style="margin-right: 16px;"><img src="https://images.opencollective.com/callemall/a6946da/logo/96.png" srcset="https://images.opencollective.com/callemall/a6946da/logo/192.png 2x" alt="call-em-all" title="The easy way to message your group" height="96" width="96" loading="lazy"></a>
</p>

Gold Sponsors are those who have pledged $500/month or more to Material-UI.
Gold Sponsors are those who have pledged \$500/month or more to Material-UI.

### There is more!

Expand Down Expand Up @@ -101,7 +102,7 @@ Yes, it's really all you need to get started as you can see in this live and int

## Questions

For *how-to* questions and other non-issues,
For _how-to_ questions and other non-issues,
please use [StackOverflow](https://stackoverflow.com/questions/tagged/material-ui) instead of Github issues.
There is a StackOverflow tag called "material-ui" that you can use to tag your questions.

Expand Down
6 changes: 3 additions & 3 deletions SECURITY.md
Expand Up @@ -6,9 +6,9 @@ The versions of the project that are currently supported with security updates.

| Version | Supported |
| ------- | ------------------ |
| 4.x | :white_check_mark: |
| 3.x | :white_check_mark: |
| < 3.0 | :x: |
| 4.x | :white_check_mark: |
| 3.x | :white_check_mark: |
| < 3.0 | :x: |
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

## Reporting a Vulnerability

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Expand Up @@ -10,7 +10,7 @@ yarn && yarn docs:dev

If you do not have yarn installed, select your OS and follow the instructions on the [Yarn website](https://yarnpkg.com/lang/en/docs/install/#mac-stable).

*DO NOT USE NPM, use Yarn to install the dependencies.*
_DO NOT USE NPM, use Yarn to install the dependencies._

## How can I add a new demo to the documentation?

Expand Down
29 changes: 18 additions & 11 deletions docs/pages/blog/2019-developer-survey-results.md
Expand Up @@ -58,6 +58,7 @@ The prefix corresponds to the number of times the concern was mentioned.
It’s sorted descending, with the most important concerns first:

- 135 **More components:**

- 56 Non-specific
- 21 Date picker
- 10 Autocomplete
Expand All @@ -83,13 +84,15 @@ It’s sorted descending, with the most important concerns first:
- 1 Transfer

- 50 **Better customization:**

- 23 Non-specific
- 15 Docs
- 8 Easier
- 3 Theme
- 1 Colors

- 36 **Better documentation:**

- 11 Non-specific
- 7 More examples
- 5 Beginner tutorials
Expand All @@ -103,24 +106,28 @@ It’s sorted descending, with the most important concerns first:
- 1 Server-side rendering

- 31 **TypeScript:**

- 14 Non-specific
- 13 Migrate more demos
- 3 withStyles -> makeStyles
- 1 Rewrite

- 24 **Performance:**

- 23 Non-specific
- 1 Table

- 19 **Bundle size**
- 17 **Material Design Update**
- 16 **styled-components:**

- 10 Support
- 6 Migration

- 14 **Fewer breaking changes**
- 10 **More page layout examples**
- 9 **Theme:**

- 3 More colors
- 3 Live editor
- 1 Non-material font example
Expand All @@ -129,6 +136,7 @@ It’s sorted descending, with the most important concerns first:
- 8 **React.StrictMode support**
- 8 **React Native support**
- 6 **Accessibility:**

- 4 Non specific
- 1 Docs
- 1 SkipNav
Expand Down Expand Up @@ -175,15 +183,15 @@ above 0 is considered “good”, +50 is “Excellent”, and above 70 is consid

Multiple options were allowed.

| Channel(s) | Number |
|-----|-----|
| Search | 344 |
| Word of mouth | 112 |
| Search, Word of mouth | 47 |
| Search, Social | 25 |
| Social | 22 |
| Blog | 14 |
| Search, Word of mouth, Blog | 11 |
| Channel(s) | Number |
| --------------------------- | ------ |
| Search | 344 |
| Word of mouth | 112 |
| Search, Word of mouth | 47 |
| Search, Social | 25 |
| Social | 22 |
| Blog | 14 |
| Search, Word of mouth, Blog | 11 |

<br /><br />
<img src="/static/blog/2019-survey/6.png" style="display: block; margin: 0 auto;" alt="Bar chart: 74.3% search, 29.6% word of mouth, 8.2% Social, 4.3% blog." />
Expand Down Expand Up @@ -230,7 +238,6 @@ it should come as no big surprise to see that the majority of respondents were p
Custom solutions have also been replaced by Material-UI as your go-to UI library, along with a
long-tail of other frameworks.


### 13. How many Material-UI based projects have you built?

<img src="/static/blog/2019-survey/13.png" style="display: block; margin: 0 auto;" alt="Pie chart: 10.7% I'm just getting started, 23.5% 1, 52.5% 2-5, 11.1% 6-10, 2.2% 10+" />
Expand Down Expand Up @@ -297,7 +304,7 @@ Multiple options were allowed.

Traditional CSS users are still prevalent (24% + 16%).
The components customization `classes` API was designed for these people.
It's also why we allow the generation of deterministic class names (*MuiButton-root* instead of *jss113*).
It's also why we allow the generation of deterministic class names (_MuiButton-root_ instead of _jss113_).

However, styled components is popular. We will work on better supporting it.

Expand Down
20 changes: 10 additions & 10 deletions docs/pages/blog/2019.md
Expand Up @@ -29,19 +29,19 @@ We soon realized that we could do way more. It was just the beginning :D.
Some of the key factors:

- The results of the [2019 Developer Survey](https://medium.com/material-ui/2019-material-ui-developer-survey-results-c9589434bbcf) have highlighted the immense potential for working on advanced components and features, especially for enterprise users.
Developers are craving for a UI framework that they can learn once (e.g. few breaking changes, only one solution per problem) and use everywhere (e.g. comprehensive, customizable, high-quality).
Developers are craving for a UI framework that they can learn once (e.g. few breaking changes, only one solution per problem) and use everywhere (e.g. comprehensive, customizable, high-quality).
- Bootstrap had successfully released [a theme store](https://themes.getbootstrap.com/).
Following this approach opened an opportunity to capture a fraction of the value Material-UI creates for its users, and funnel it back into R&D on the framework.
- The market for paid UI components is in the order of a couple of $100m/year,
with dozens of companies positioned in this market.
While React is only one technology among many (jQuery, Angular, ASP.NET, Blazor, Vue, WPF, UWP, etc) with which to build a UI, but we believe that Web and React will become the dominant technology in the next 5 years for enterprises. Material-UI is uniquely positioned to address this market with non-MIT features.
Following this approach opened an opportunity to capture a fraction of the value Material-UI creates for its users, and funnel it back into R&D on the framework.
- The market for paid UI components is in the order of a couple of \$100m/year,
with dozens of companies positioned in this market.
While React is only one technology among many (jQuery, Angular, ASP.NET, Blazor, Vue, WPF, UWP, etc) with which to build a UI, but we believe that Web and React will become the dominant technology in the next 5 years for enterprises. Material-UI is uniquely positioned to address this market with non-MIT features.
- Building UIs should be simpler, it still too slow and complex.
Designers and developers should benefit from a more integrated experience.
Designers and developers should benefit from a more integrated experience.
- Every now and then, we witness the appearance of a new React UI component library built from scratch ([UXPin](https://adele.uxpin.com/) keeps track of some of them).
And every time we asked ourselves, "what could have we done differently to empower this library"?
We believe that starting from scratch, while maximizing freedom, is incredibly inefficient.
Most UI libraries need the same features but are implemented with a wide spectrum of accessibility, developer experience, and overall design quality.
We won't rest until we successfully unify these efforts. It's a long term mission and will probably take years. The foundation will be the release of an un-styled version of our components.
And every time we asked ourselves, "what could have we done differently to empower this library"?
We believe that starting from scratch, while maximizing freedom, is incredibly inefficient.
Most UI libraries need the same features but are implemented with a wide spectrum of accessibility, developer experience, and overall design quality.
We won't rest until we successfully unify these efforts. It's a long term mission and will probably take years. The foundation will be the release of an un-styled version of our components.

## Achievements

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/blog/2020-introducing-sketch.md
Expand Up @@ -30,7 +30,7 @@ For a long time, we have ignored the problem. We were recommending users to try

- **Sketch** has [some symbols](https://i.stack.imgur.com/vEEAA.png) for Material Design. Unfortunately, they cover <30% of the components available in Material-UI, use an outdated version of the specification, and focus on mobile (leaving desktop behind).
- **Material Design** had a [Sketch plugin](https://material.io/resources/theme-editor/).
Unfortunately, it was recently retired, was supporting fewer components than Material-UI, and didn't use the same wording/structure as Material-UI that made it harder to move from design to implementation.
Unfortunately, it was recently retired, was supporting fewer components than Material-UI, and didn't use the same wording/structure as Material-UI that made it harder to move from design to implementation.
- Anything else is paid.

### Gain efficiency
Expand Down
12 changes: 7 additions & 5 deletions docs/pages/blog/2020-q1-update.md
Expand Up @@ -43,6 +43,7 @@ Here are the most significant improvements since the beginning of the year:
</video>

- ⚛️ We have worked on improving developer experience inside text editors.

- We have migrated prop descriptions from JSDoc to TypeScript for 60% of the components. Back-and-forths with the documentation API will be less frequent:

![props](/static/blog/2020-q1-update/props.png)
Expand All @@ -65,11 +66,11 @@ But this summary is just scratching the surface. We have accepted 572 commits fr

We are thrilled to welcome two new full-time developers on Material-UI:

- [Dmitriy Kovalenko](https://github.com/dmtrKovalenko), the author of @material-ui/pickers.
<img src="https://avatars0.githubusercontent.com/u/16926049" alt="dmitriy" style="max-width: 160px; margin: unset; margin-bottom: 24px; border-radius: 2px;" />
- [Dmitriy Kovalenko](https://github.com/dmtrKovalenko), the author of @material-ui/pickers.
<img src="https://avatars0.githubusercontent.com/u/16926049" alt="dmitriy" style="max-width: 160px; margin: unset; margin-bottom: 24px; border-radius: 2px;" />

- [Damien Tassone](https://github.com/dtassone/), an experienced developer in the finance industry.
<img src="https://avatars0.githubusercontent.com/u/936978" alt="damien" style="max-width: 160px; margin: unset; margin-bottom: 24px; border-radius: 2px;" />
- [Damien Tassone](https://github.com/dtassone/), an experienced developer in the finance industry.
<img src="https://avatars0.githubusercontent.com/u/936978" alt="damien" style="max-width: 160px; margin: unset; margin-bottom: 24px; border-radius: 2px;" />

### Growth between Q4 2019 and Q1 2020

Expand All @@ -93,12 +94,13 @@ We'll do our best, no guarantee!
<img src="/static/blog/2020-q1-update/chinese.png" alt="chinese" style="max-width: 134px; margin-bottom: 24px;" />

- 🔥 We will start to work on the [next major: v5](https://github.com/mui-org/material-ui/issues/20012).
You can expect the following:
You can expect the following:

- A feature freeze on v4.
- The introduction of deprecation messages in the next v4 minors. These messages will help developers upgrade to v5.
- A progressive bug fixes freeze on v4, with the exception of security issues and important bugs.
- At least 6 months of work on v5 to get to a stable release (probably more). You can follow our progress using our [milestone](https://github.com/mui-org/material-ui/milestone/35).

- 🧑‍💻 We will likely look to hire a new full-time member on the core team to help deliver v5 and new features faster.
- ⌗ We announced, back in [October 2019](/blog/september-2019-update/#our-roadmap-intent-for-october), our intention to work on an advanced data grid component. The task was bigger than anticipated, but we are making progress. It might take us 12 months to do it right. Damien is now leading and fully dedicated to this effort. You can follow our early-stage progress on [finui.io](https://finui.io/#/grid) and later, integration into the mono-repository on [#18872](https://github.com/mui-org/material-ui/pull/18872).

Expand Down
4 changes: 3 additions & 1 deletion docs/pages/blog/april-2019-update.md
Expand Up @@ -14,6 +14,7 @@ Here are the most significant improvements in April:

This was only possible thanks to the contributions **@merceyz**, **@sperry94**, **@jasondashwang**, **@bh1505**, **@donigianrp**, **@Dudrie**, **@eluchsinger**, **@cahilfoley**, **@gabrielgene**, **@kenzhemir**, **@Adherentman**, **@lksilva**, **@Tevinthuku**. Thank you!
Supporting these TypeScript demos has one important implication, it forces us to have working TypeScript definitions ✨.

- 🎀 We have migrated a large chunk of our components from classes to hooks. **@joshwooding** has lead the effort. We will explain why in the v4 release blog post.
- 📐 We have updated our components to better match the Material Design specification
(Snackbar, List, Checkbox, Radio & Switch).
Expand All @@ -34,6 +35,7 @@ Here are the most significant improvements in April:
- 💄 We have added support for responsive font sizes. You can wrap your theme with [`responsiveFontSizes()`](/customization/typography/#responsive-font-sizes):

[![Responsive font sizes](/static/blog/april-2019-update/responsive.png)](/customization/typography/#responsive-font-sizes)

- We have added support for custom [header scroll behaviors](/components/app-bar/#scrolling):

<video src="/static/blog/april-2019-update/scroll-trigger.mp4" controls loop autoplay></video>
Expand All @@ -42,7 +44,7 @@ But this summary is just scratching the surface. We have accepted 243 commits fr

## Our roadmap intent for May

*(We'll do our best, no guarantee!)*
_(We'll do our best, no guarantee!)_

- We will release Material-UI v4 stable during the React Europe conference.
- We will start an effort to support more components. So far, we have identified a couple of useful ones:
Expand Down