Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

Commit

Permalink
docs: Add Glitch projects to getting started READMEs (#4196)
Browse files Browse the repository at this point in the history
  • Loading branch information
bonniezhou authored Jan 11, 2019
1 parent e718cb2 commit 4688971
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Material Components for the web is the successor to [Material Design Lite](https
- [Getting Started Guide](docs/getting-started.md)
- [Demos](https://material-components.github.io/material-components-web-catalog)
- [MDC Web on other frameworks](docs/framework-wrappers.md)
- [Examples using MDC Web](docs/examples.md)
- [Contributing](CONTRIBUTING.md)
- [Material Design Guidelines](https://material.io/design) (external site)
- [Supported browsers](docs/supported-browsers.md)
Expand Down Expand Up @@ -56,6 +57,8 @@ Material Components for the web is the successor to [Material Design Lite](https
### Using NPM

> This guide assumes you have webpack configured to compile Sass into CSS. To configure webpack, please see the full [getting started guide](docs/getting-started.md). You can also see the final code and result in the [Material Starter Kit](https://glitch.com/~material-starter-kit).
Install textfield node module to your project.

```
Expand Down Expand Up @@ -95,8 +98,6 @@ This'll initialize text field component on a single `.mdc-text-field` element.

> Please see [quick start demo](https://stackblitz.com/edit/mdc-web-quick-start-demo) on stackblitz for full example.
> Please see [getting started guide](docs/getting-started.md) for pointers on how to configure webpack to bundle JavaScript & CSS.
## Need help?

We're constantly trying to improve our components. If Github Issues don't fit your needs, then please visit us on our [Discord Channel](https://discord.gg/material-components).
Expand Down
11 changes: 11 additions & 0 deletions docs/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!--docs:
title: "Examples"
layout: landing
section: docs
path: /docs/examples/
-->

# Examples using MDC Web

- [Shrine](https://glitch.com/~material-example-app-shrine) - An e-commerce app using Text Field, Button, Drawer, List, Image List and Material Theming capabilities. You can build Shrine from scratch by walking through the Google Developers Codelabs [MDC-101 Web](https://codelabs.developers.google.com/codelabs/mdc-101-web), [MDC-102 Web](https://codelabs.developers.google.com/codelabs/mdc-102-web), and [MDC-103 Web](https://codelabs.developers.google.com/codelabs/mdc-103-web).
- [Adopt a Pup](https://glitch.com/~adopt-a-pup) - A pet adoption app using Top App Bar, Tabs, Layout Grid, Card, Text Field, Chips, and Material Theming capabilities
2 changes: 2 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ However, for optimal results, we recommend consuming MDC Web's ES2015 modules an

This section walks through how to [install MDC Web Node modules](https://www.npmjs.com/org/material), and bundle the Sass and JavaScript from those Node modules in your [webpack](https://webpack.js.org/) configuration.

You can also see the final code and result in the [Material Starter Kit](https://glitch.com/~material-starter-kit).

> Note: This guide assumes you have Node.js and npm installed locally.
### Step 1: Webpack with Sass
Expand Down

0 comments on commit 4688971

Please sign in to comment.