[docs] Setup a new next.js application for documentation #299
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brijeshb42
force-pushed
the
docs-setup
branch
from
f042409 to
d899dbd
Compare
brijeshb42
force-pushed
the
docs-setup
branch
5 times, most recently
from
5780e3e to
0265ee2
Compare
brijeshb42
added
scope: docs-infra
added 4 commits
November 5, 2024 15:16
This app only uses Pigment and some CSS module for styling and will serve as an internal dogfood for us.
brijeshb42
force-pushed
the
docs-setup
branch
from
0265ee2 to
66e8d13
Compare
mnajdova
approved these changes
Nov 5, 2024
|
|
||
| ## Installation | ||
|
|
||
| Pigment CSS has two category of packages. First one is to be imported and used in your source code. This includes the public API of the package. Second category is to be imported in your bundler config file to configure and actually be able to use Pigment CSS. We currently support [`Next.js`](https://nextjs.org/) (no Turbopack yet), [`Vite`](https://vite.dev/) and [`Webpack`](https://webpack.js.org/). |
There was a problem hiding this comment.
Suggested change
| Pigment CSS has two category of packages. First one is to be imported and used in your source code. This includes the public API of the package. Second category is to be imported in your bundler config file to configure and actually be able to use Pigment CSS. We currently support [`Next.js`](https://nextjs.org/) (no Turbopack yet), [`Vite`](https://vite.dev/) and [`Webpack`](https://webpack.js.org/). | |
| Pigment CSS has two category of packages. | |
| First one is to be imported and used in your source code. | |
| This includes the public API of the package. | |
| Second category is to be imported in your bundler config file to configure and actually be able to use Pigment CSS. | |
| We currently support [`Next.js`](https://nextjs.org/) (no Turbopack yet), [`Vite`](https://vite.dev/) and [`Webpack`](https://webpack.js.org/). |
Not important for this PR, but putting each sentence in a new line, makes the review so much easier. This is the convention we use in the Material UI's docs
There was a problem hiding this comment.
Will do in separate PRs. This wasn't even real content.
docs/next.config.ts
Outdated
| const DATA_DIR = path.join(process.cwd(), 'data'); | ||
|
|
||
| const nextConfig: NextConfig = { | ||
| /* config options here */ |
There was a problem hiding this comment.
Suggested change
| /* config options here */ |
brijeshb42
force-pushed
the
docs-setup
branch
from
805e5ea to
7be2a78
Compare
I'll merge this and do more refinements (point 2 and 3) in separate PRs. |
|
Sounds good 👍 |
| 'react/react-in-jsx-scope': 'off', | ||
| 'react/no-unknown-property': ['error', { ignore: ['sx'] }], | ||
| 'import/extensions': [ | ||
| 'error', |
There was a problem hiding this comment.
Config will need to move to the root folder eslint config file to prepare Eslint v9 upgrade.
|
I wired it to https://pigment-css.com/ with |
I think we could have waited with this. Maybe we can make the Landing page with something like "Under construction" and don't like the docs yet. cc @brijeshb42 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This app only uses Pigment and some CSS module for styling and will serve as an internal dogfood for us.
The styling and most of the mdx related logic has been taken from the Base UI docs.
Similarly, it uses the app router with static export to build the whole docs statically that we can then deploy on Netlify.
Preview - https://deploy-preview-299--pigment-css.netlify.app/