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][pigment] Add example and guide section #41249

Merged
merged 10 commits into from Mar 8, 2024

Conversation

siriwatknp
Copy link
Member

@siriwatknp siriwatknp added docs Improvements or additions to the documentation package: pigment-css Specific to @pigment-css/* labels Feb 23, 2024
@mui-bot
Copy link

mui-bot commented Feb 23, 2024

Netlify deploy preview

https://deploy-preview-41249--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against ff6f852

Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few writing tweaks here!

packages/zero-runtime/README.md Outdated Show resolved Hide resolved
packages/zero-runtime/README.md Outdated Show resolved Hide resolved
packages/zero-runtime/README.md Outdated Show resolved Hide resolved
packages/zero-runtime/README.md Outdated Show resolved Hide resolved
packages/zero-runtime/README.md Outdated Show resolved Hide resolved
packages/zero-runtime/README.md Outdated Show resolved Hide resolved
Co-authored-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com>
Signed-off-by: Siriwat K <siriwatkunaporn@gmail.com>
@brijeshb42
Copy link
Contributor

Can you also add the details about the required @mui/zero-runtime/styles.css import to the entry file ?

Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick edit suggestions

packages/zero-runtime/README.md Outdated Show resolved Hide resolved
packages/zero-runtime/README.md Outdated Show resolved Hide resolved
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 1, 2024
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 4, 2024
Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few edits but already dropping the tentative approval! 👌

@@ -1,6 +1,6 @@
# Pigment CSS

A zero-runtime CSS-in-JS library that extracts the colocated styles to their own CSS files at build-time.
A Pigment CSS CSS-in-JS library that extracts the colocated styles to their own CSS files at build-time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A Pigment CSS CSS-in-JS library that extracts the colocated styles to their own CSS files at build-time.
Pigment CSS is a zero-runtime CSS-in-JS library that extracts the colocated styles to their own CSS files at build time.


## Getting started

Pigment CSS supports Next.js and Vite with support for more bundlers in future. You must install the corresponding plugin, as shown below.

### Next.js

#### Starter template

Use the following commands to create a new Next.js project with Zero Runtime setup:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use the following commands to create a new Next.js project with Zero Runtime setup:
Use the following commands to create a new Next.js project with Pigment CSS set up:

packages/pigment-react/README.md Outdated Show resolved Hide resolved
packages/pigment-react/README.md Outdated Show resolved Hide resolved
packages/pigment-react/README.md Outdated Show resolved Hide resolved
@siriwatknp siriwatknp changed the title [docs][zero] Add example and guide section [docs][pigment] Add example and guide section Mar 8, 2024
@siriwatknp siriwatknp enabled auto-merge (squash) March 8, 2024 03:39
@siriwatknp siriwatknp merged commit 13a36f7 into mui:master Mar 8, 2024
18 checks passed
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation package: pigment-css Specific to @pigment-css/*
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants