DEV/material-components_material-web
1
0
Fork 0
mirror of https://github.com/material-components/material-web.git synced 2026-01-09 07:21:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update quick-start

Browse Source 
PiperOrigin-RevId: 569278595
This commit is contained in:
Elizabeth Mitchell 2023-09-28 13:43:13 -07:00 committed by Copybara-Service
parent 5a65c09d15
commit 6be6dd8e12
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/quick-start.md
View File

@ -8,16 +8,18 @@ order: 2
<!--*
# Document freshness: For more information, see go/fresh-source.
freshness: { owner: 'lizmitchell' reviewed: '2023-01-23' }
freshness: { owner: 'lizmitchell' reviewed: '2023-09-28' }
tag: 'docType:gettingStarted'
*-->
<!-- go/mwc/docs/quick-start -->
<!-- go/mwc-quick-start -->
<!-- [TOC] -->
## Install
<!--#include file="../googlers/quick-start-install.md" -->
Install Material web components using
[npm and node](https://nodejs.org)<!-- {.external} -->.
@ -37,6 +39,8 @@ import '@material/web/button/outlined-button.js';
import '@material/web/checkbox/checkbox.js';
```
<!--#include file="../googlers/quick-start-import.md" -->
## Usage
Use the `<component-name>` tag in HTML markup. Refer to the
@ -58,6 +62,8 @@ Use the `<component-name>` tag in HTML markup. Refer to the
## Building
<!--#include file="../googlers/quick-start-build.md" -->
Material web components uses bare module specifiers that must be resolved with
tools until [import maps](https://github.com/WICG/import-maps)<!-- {.external} --> are
adopted.
@ -81,7 +87,7 @@ Create a bundle from an entrypoint `index.js` file and use it in a `<script>`
`"src"` attribute.
```shell
npx rollup -p @rollup/plugin-node-resolve index.js > bundle.js
npx rollup -p @rollup/plugin-node-resolve index.js -o bundle.js
```
```html