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

[CONTRIBUTING] Update the docs #11078

Merged
merged 1 commit into from
Apr 20, 2018
Merged

[CONTRIBUTING] Update the docs #11078

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Please create a new branch from an up to date v1-beta on your fork. (Note, urgen
5. Visit GitHub and make your pull request.

If you have an existing local repository, please update it before you start, to minimise the chance of merge conflicts.
```js
```sh
git remote add upstream git@github.com:mui-org/material-ui.git
git checkout v1-beta
git pull upstream v1-beta
Expand All @@ -46,7 +46,7 @@ yarn

The documentation site is built with Material-UI and contains examples of all the components.
To get started:
```js
```sh
yarn
yarn docs:dev
```
Expand Down Expand Up @@ -102,8 +102,8 @@ pages/demos/buttons.js
Then, you will need to add the following code:
```diff
+ 'pages/demos/buttons/SuperButtons.js': {
+ js: require('docs/src/pages/demos/buttons/SuperButtons').default,
+ raw: preval`
+ js: require('docs/src/pages/demos/buttons/SuperButtons').default,
+ raw: preval`
+ module.exports = require('fs')
+ .readFileSync(require.resolve('docs/src/pages/demos/buttons/SuperButtons'), 'utf8')
+`,
Expand All @@ -122,6 +122,7 @@ First, you have to build your local distribution of Material-UI:

```shell
# From the root folder of the material-ui project
cd packages/material-ui
yarn build
```

Expand Down