-
-
Notifications
You must be signed in to change notification settings - Fork 355
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] Polish to match standard #4344
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,47 +4,47 @@ title: Toolpad Core - Installation | |
|
||
# Installation | ||
|
||
## Manual Installation | ||
<p class="description">Learn how to install Toolpad Core in your local environment.</p> | ||
|
||
## Manual installation | ||
Comment on lines
-7
to
+9
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sentence case There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we make vale catch these? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could use https://vale.sh/docs/topics/styles/#capitalization. But two challenges:
|
||
|
||
Use your preferred package manager to install `@toolpad/core` in your project: | ||
|
||
<codeblock storageKey="package-manager"> | ||
|
||
```bash npm | ||
npm install -S @toolpad/core | ||
``` | ||
|
||
```bash yarn | ||
yarn add @toolpad/core | ||
npm install @toolpad/core | ||
``` | ||
|
||
```bash pnpm | ||
pnpm add @toolpad/core | ||
``` | ||
|
||
```bash yarn | ||
yarn add @toolpad/core | ||
``` | ||
|
||
</codeblock> | ||
|
||
The Toolpad Core package has a peer dependency on `@mui/material` and `@mui/icons-material`. If you aren't using these already in your project, you can install them with: | ||
|
||
<codeblock storageKey="package-manager"> | ||
|
||
```bash npm | ||
npm install -S @mui/material @mui/icons-material @emotion/react @emotion/styled | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove the |
||
``` | ||
|
||
```bash yarn | ||
yarn add @mui/material @mui/icons-material @emotion/react @emotion/styled | ||
npm install @mui/material @mui/icons-material @emotion/react @emotion/styled | ||
``` | ||
|
||
```bash pnpm | ||
pnpm add @mui/material @mui/icons-material @emotion/react @emotion/styled | ||
``` | ||
|
||
</codeblock> | ||
```bash yarn | ||
yarn add @mui/material @mui/icons-material @emotion/react @emotion/styled | ||
``` | ||
|
||
## Automatic Installation | ||
</codeblock> | ||
|
||
<p class="description">Learn how to install Toolpad Core in your local environment.</p> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Wrong position |
||
## Automatic installation | ||
|
||
1. Run the following command to start Toolpad Core: | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,14 +13,14 @@ Then run the command: | |
npx create-toolpad-app@latest --studio my-toolpad-app | ||
``` | ||
|
||
```bash yarn | ||
yarn create toolpad-app --studio my-toolpad-app | ||
``` | ||
|
||
```bash pnpm | ||
pnpm create toolpad-app --studio my-toolpad-app | ||
``` | ||
|
||
```bash yarn | ||
yarn create toolpad-app --studio my-toolpad-app | ||
``` | ||
|
||
</codeblock> | ||
|
||
This will run the `create-toolpad-app` CLI which initializes the directory `./my-toolpad-app` with a Toolpad Studio application. | ||
|
@@ -41,14 +41,14 @@ Then start the development mode | |
npm run dev | ||
``` | ||
|
||
```bash yarn | ||
yarn dev | ||
``` | ||
|
||
```bash pnpm | ||
pnpm dev | ||
``` | ||
|
||
```bash yarn | ||
yarn dev | ||
``` | ||
|
||
</codeblock> | ||
|
||
This starts the development server on port `3000` or the first available port after that and opens the browser to the Toolpad Studio editor. | ||
|
@@ -60,17 +60,17 @@ Start by installing the required dependencies: | |
<codeblock storageKey="package-manager"> | ||
|
||
```bash npm | ||
npm install -S @toolpad/studio | ||
``` | ||
|
||
```bash yarn | ||
yarn add @toolpad/studio | ||
npm install @toolpad/studio | ||
``` | ||
|
||
```bash pnpm | ||
pnpm add @toolpad/studio | ||
``` | ||
|
||
```bash yarn | ||
yarn add @toolpad/studio | ||
``` | ||
|
||
</codeblock> | ||
|
||
Then you'll have to add the Toolpad Studio scripts to your `package.json`: | ||
|
@@ -94,14 +94,14 @@ Now you can start your Toolpad Studio application using one of the commands: | |
npm run toolpad-studio:dev | ||
``` | ||
|
||
```bash yarn | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Iterate on mui/mui-public#181. |
||
yarn toolpad-studio:dev | ||
``` | ||
|
||
```bash pnpm | ||
pnpm toolpad-studio:dev | ||
``` | ||
|
||
```bash yarn | ||
yarn toolpad-studio:dev | ||
``` | ||
|
||
</codeblock> | ||
|
||
When you run this command, Toolpad Studio will automatically initialize a new application in the **./my-toolpad-app** folder. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,6 @@ title: Toolpad Studio docs - Home | |
|
||
# Toolpad Studio | ||
|
||
<p class="description">Toolpad Studio docs</p> | ||
<p class="description">Toolpad Studio docs.</p> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can enforce this in docs-infra: mui/material-ui#44292. |
||
|
||
Low code tool, for developers, powered by MUI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bharatkashyap Similar to #4306, I fixed a couple more to match https://www.notion.so/mui-org/Writing-style-guide-2a957a4168a54d47b14bae026d06a24b.
cc @samuelsycamore we are progressively getting to match the style guide everywhere 😄