A clone of M3 Material docs

[EAzari]

Is it possible clone M3 Material docs and start to put Web Components and their docs in their places, to see which components are developed and which are missing

Also, it will help community to use components better

[VandeurenGlenn]

@EAzari
Made one quick, don't mind the colors, was playing with colorThief
It basically just uses the readme's from the docs
https://vandeurenglenn.github.io/unofficial-material-web-catalog/#!/button

[vdegenne]

@VandeurenGlenn Yeah this is just the doc. I think the OP meant to make a catalog with the actual usage of the components.

[VandeurenGlenn]

I thought docs were kinda doing this? But in a basic way ofc.
I thought the elements in docs are elements that quite stable already/explain enough to work with them.

[kavishdevar]

Maybe check docs website.. It includes a few components with their usages..

[e111077]

This is going to be the official doc source and should be linked out from material.io in the coming months. The components on there are the ones that are fully documented.

Please note, the URL may change in the coming weeks to something more official

[e111077]

See update here

+1 to what @stiblook said, but I wanted to say, if you'd like to improve the docs website, we could always use some help with PRs in writing up some READMEs in the docs/ folder. If you'd like to see it rendered in the catalog, follow these instructions:

1. clone the repo:

   git clone [email protected]:material-components/material-web

2. cd into the catalog directory

   cd material-web/catalog

3. install deps

   npm ci

4. run the catalog in dev mode

   npm run dev

5. Edit docs in /docs root folder and include the commented out frontmatter to render in docs sidebar. You can follow Checkbox as an example.

[VandeurenGlenn]

After rerun works

[vdegenne]

Not really. Sure it pass the failing stage, but have you tried to modify a file to trigger a change?

[VandeurenGlenn]

@vdegenne
Yup I forgot to trigger changes, after +-3 times it fails

@e111077

[kavishdevar]

had the same issue.. it crashes after sometime.. i set the memory using the flag --max-old-space-size, and got the same error, now.

[kavishdevar]

Also, @e111077, I tried adding docs for textfield, and render it on the catalog, I can't seem to get the components rendered, do I need to change the imports or something anywhere?

EDIT: nvm, got it, need it edit catalog/src/ssr.ts

[e111077]

Update. Official material design docs should be updated to link out to "web - MWC"

See checkbox docs for example

That should link to our GitHub docs and eventually to material-web.dev when we have completed that site post 1.0 (here it is for checkbox).

We intend to put up more comprehensive examples on material-web.dev post 1.0 launch as 1.0 we are focusing on code quality and github docs