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.

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

Jump to bottom

[docs] Improve installation instructions for running the docs locally #15608

Merged
merged 2 commits into from May 7, 2019
Merged

[docs] Improve installation instructions for running the docs locally #15608

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2d0ea8
updated README.md
andreawaxman May 6, 2019
ece9702
shorter note
oliviertassinari May 7, 2019
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
8 changes: 6 additions & 2 deletions docs/README.md
View file
Open in desktop
Expand Up @@ -8,12 +8,16 @@ To start the docs site in development mode, from the project root, run:
yarn && yarn start
```

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.*

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

[You can follow this guide](https://github.com/mui-org/material-ui/blob/next/CONTRIBUTING.md)
on how to get started contributing to Material-UI.

## How do I help improve to the translations?

Please visit https://translate.material-ui.com/ where you will be able to select a language
and edit the translations. Please don't submit pull requests directly.
Please visit https://translate.material-ui.com/ where you will be able to select a language and edit the translations.
Please don't submit pull requests directly.