chore: apply prettier to all *.md files

open-wc · Oct 23, 2019 · 1cda471 · 1cda471
1 parent 407baa1
commit 1cda471
Show file tree

Hide file tree

Showing 50 changed files with 844 additions and 559 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -31,7 +31,7 @@ Make your changes to the project. Commits are linted using precommit hooks, mean
 # Committing Your Changes
 
 Open WC uses [commitlint](https://github.com/marionebl/commitlint) to standardize commit messages in the project. Commit messages must follow the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)
-Open WC uses package name as scope. So for example if you fix a *terrible bug* in the package `@open-wc/testing`, the commit message should look like this:
+Open WC uses package name as scope. So for example if you fix a _terrible bug_ in the package `@open-wc/testing`, the commit message should look like this:
 
 ```
 fix(testing): fix terrible bug

diff --git a/README.md b/README.md
@@ -1,20 +1,23 @@
 <p align="center"><img src="https://github.com/open-wc/open-wc/blob/master/assets/images/logo.png" width="200" alt="Open-wc Logo" /></p>
 
 # Open Web Component Recommendations
+
 Open Web Components provides a set of defaults, recommendations and tools to help facilitate your web component project. Our recommendations include: developing, linting, testing, building, tooling, demoing, publishing and automating.
 
 [![CircleCI](https://circleci.com/gh/open-wc/open-wc.svg?style=shield)](https://circleci.com/gh/open-wc/open-wc)
 [![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=M2UrSFVRang2OWNuZXlWSlhVc3FUVlJtTDkxMnp6eGFDb2pNakl4bGxnbz0tLUE5RjhCU0NUT1ZWa0NuQ3MySFFWWnc9PQ==--86f7fac07cdbd01dd2b26ae84dc6c8ca49e45b50)](https://www.browserstack.com/automate/public-build/M2UrSFVRang2OWNuZXlWSlhVc3FUVlJtTDkxMnp6eGFDb2pNakl4bGxnbz0tLUE5RjhCU0NUT1ZWa0NuQ3MySFFWWnc9PQ==--86f7fac07cdbd01dd2b26ae84dc6c8ca49e45b50)
 [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
 
 ## Usage
+
 ```bash
 # in a new or existing folder:
 npm init @open-wc
 # requires node 10 & npm 6 or higher
 ```
 
 This will kickstart a menu guiding you through all available actions.
+
 ```
 $ npm init @open-wc
 npx: installed 14 in 4.074s
@@ -25,44 +28,46 @@ What would you like to do today?
 ```
 
 ## Homepage
+
 For more details please visit us at [open-wc.org](https://open-wc.org).
 
 ## Packages
 
-| Package | Version | Description |
-|------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [building-rollup](./packages/building-rollup) | [![building-rollup](https://img.shields.io/npm/v/@open-wc/building-rollup.svg)](https://www.npmjs.com/package/@open-wc/building-rollup) | Default configuration for working with rollup. |
-| [building-webpack](./packages/building-webpack) | [![building-webpack](https://img.shields.io/npm/v/@open-wc/building-webpack.svg)](https://www.npmjs.com/package/@open-wc/building-webpack) | Default configuration for working with webpack. |
-| [chai-dom-equals](./packages/chai-dom-equals) | [![chai-dom-equals](https://img.shields.io/npm/v/@open-wc/chai-dom-equals.svg)](https://www.npmjs.com/package/@open-wc/chai-dom-equals) | Chai Plugin to compare dom and shadow dom trees. Part of open-wc recommendations. |
-| [create](./packages/create) | [![create](https://img.shields.io/npm/v/@open-wc/create.svg)](https://www.npmjs.com/package/@open-wc/create) | Scaffold web components following open-wc recommendations. |
-| [demoing-storybook](./packages/demoing-storybook) | [![demoing-storybook](https://img.shields.io/npm/v/@open-wc/demoing-storybook.svg)](https://www.npmjs.com/package/@open-wc/demoing-storybook) | Storybook configuration following open-wc recommendations. |
-| [eslint-config](./packages/eslint-config) | [![eslint-config](https://img.shields.io/npm/v/@open-wc/eslint-config.svg)](https://www.npmjs.com/package/@open-wc/eslint-config) | Eslint configuration following open-wc recommendations. |
-| [es-dev-server](./packages/es-dev-server) | [![es-dev-server](https://img.shields.io/npm/v/es-dev-server.svg)](https://www.npmjs.com/package/es-dev-server) | Development server for modern web apps. |
-| [polyfills-loader](./packages/polyfills-loader) | [![polyfills-loader](https://img.shields.io/npm/v/@open-wc/polyfills-loader.svg)](https://www.npmjs.com/package/@open-wc/polyfills-loader) | Load web component polyfills using dynamic imports. |
-| [prettier-config](./packages/prettier-config) | [![prettier-config](https://img.shields.io/npm/v/@open-wc/prettier-config.svg)](https://www.npmjs.com/package/@open-wc/prettier-config) | Prettier configuration following open-wc recommendations. |
-| [semantic-dom-diff](./packages/semantic-dom-diff) | [![semantic-dom-diff](https://img.shields.io/npm/v/@open-wc/semantic-dom-diff.svg)](https://www.npmjs.com/package/@open-wc/semantic-dom-diff) | To compare dom and shadow dom trees. Part of open-wc recommendations. |
-| [testing](./packages/testing) | [![testing](https://img.shields.io/npm/v/@open-wc/testing.svg)](https://www.npmjs.com/package/@open-wc/testing) | Testing following open-wc recommendations. |
-| [testing-helpers](./packages/testing-helpers) | [![testing-helpers](https://img.shields.io/npm/v/@open-wc/testing-helpers.svg)](https://www.npmjs.com/package/@open-wc/testing-helpers) | Testing Helpers following open-wc recommendations. |
-| [testing-karma](./packages/testing-karma) | [![testing-karma](https://img.shields.io/npm/v/@open-wc/testing-karma.svg)](https://www.npmjs.com/package/@open-wc/testing-karma) | Testing with Karma following open-wc recommendations. |
-| [testing-karma-bs](./packages/testing-karma-bs) | [![testing-karma-bs](https://img.shields.io/npm/v/@open-wc/testing-karma-bs.svg)](https://www.npmjs.com/package/@open-wc/testing-karma-bs) | Testing with Karma using Browserstack following open-wc recommendations. |
-| [testing-wallaby](./packages/testing-wallaby) | [![testing-wallaby](https://img.shields.io/npm/v/@open-wc/testing-wallaby.svg)](https://www.npmjs.com/package/@open-wc/testing-wallaby) | Testing with wallaby following open-wc recommendations. |
-| [webpack-import-meta-loader](./packages/webpack-import-meta-loader) | [![webpack-import-meta-loader](https://img.shields.io/npm/v/@open-wc/webpack-import-meta-loader.svg)](https://www.npmjs.com/package/@open-wc/webpack-import-meta-loader) | Webpack loader plugin to support import.meta. |
+| Package                                                             | Version                                                                                                                                                                  | Description                                                                       |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- |
+| [building-rollup](./packages/building-rollup)                       | [![building-rollup](https://img.shields.io/npm/v/@open-wc/building-rollup.svg)](https://www.npmjs.com/package/@open-wc/building-rollup)                                  | Default configuration for working with rollup.                                    |
+| [building-webpack](./packages/building-webpack)                     | [![building-webpack](https://img.shields.io/npm/v/@open-wc/building-webpack.svg)](https://www.npmjs.com/package/@open-wc/building-webpack)                               | Default configuration for working with webpack.                                   |
+| [chai-dom-equals](./packages/chai-dom-equals)                       | [![chai-dom-equals](https://img.shields.io/npm/v/@open-wc/chai-dom-equals.svg)](https://www.npmjs.com/package/@open-wc/chai-dom-equals)                                  | Chai Plugin to compare dom and shadow dom trees. Part of open-wc recommendations. |
+| [create](./packages/create)                                         | [![create](https://img.shields.io/npm/v/@open-wc/create.svg)](https://www.npmjs.com/package/@open-wc/create)                                                             | Scaffold web components following open-wc recommendations.                        |
+| [demoing-storybook](./packages/demoing-storybook)                   | [![demoing-storybook](https://img.shields.io/npm/v/@open-wc/demoing-storybook.svg)](https://www.npmjs.com/package/@open-wc/demoing-storybook)                            | Storybook configuration following open-wc recommendations.                        |
+| [eslint-config](./packages/eslint-config)                           | [![eslint-config](https://img.shields.io/npm/v/@open-wc/eslint-config.svg)](https://www.npmjs.com/package/@open-wc/eslint-config)                                        | Eslint configuration following open-wc recommendations.                           |
+| [es-dev-server](./packages/es-dev-server)                           | [![es-dev-server](https://img.shields.io/npm/v/es-dev-server.svg)](https://www.npmjs.com/package/es-dev-server)                                                          | Development server for modern web apps.                                           |
+| [polyfills-loader](./packages/polyfills-loader)                     | [![polyfills-loader](https://img.shields.io/npm/v/@open-wc/polyfills-loader.svg)](https://www.npmjs.com/package/@open-wc/polyfills-loader)                               | Load web component polyfills using dynamic imports.                               |
+| [prettier-config](./packages/prettier-config)                       | [![prettier-config](https://img.shields.io/npm/v/@open-wc/prettier-config.svg)](https://www.npmjs.com/package/@open-wc/prettier-config)                                  | Prettier configuration following open-wc recommendations.                         |
+| [semantic-dom-diff](./packages/semantic-dom-diff)                   | [![semantic-dom-diff](https://img.shields.io/npm/v/@open-wc/semantic-dom-diff.svg)](https://www.npmjs.com/package/@open-wc/semantic-dom-diff)                            | To compare dom and shadow dom trees. Part of open-wc recommendations.             |
+| [testing](./packages/testing)                                       | [![testing](https://img.shields.io/npm/v/@open-wc/testing.svg)](https://www.npmjs.com/package/@open-wc/testing)                                                          | Testing following open-wc recommendations.                                        |
+| [testing-helpers](./packages/testing-helpers)                       | [![testing-helpers](https://img.shields.io/npm/v/@open-wc/testing-helpers.svg)](https://www.npmjs.com/package/@open-wc/testing-helpers)                                  | Testing Helpers following open-wc recommendations.                                |
+| [testing-karma](./packages/testing-karma)                           | [![testing-karma](https://img.shields.io/npm/v/@open-wc/testing-karma.svg)](https://www.npmjs.com/package/@open-wc/testing-karma)                                        | Testing with Karma following open-wc recommendations.                             |
+| [testing-karma-bs](./packages/testing-karma-bs)                     | [![testing-karma-bs](https://img.shields.io/npm/v/@open-wc/testing-karma-bs.svg)](https://www.npmjs.com/package/@open-wc/testing-karma-bs)                               | Testing with Karma using Browserstack following open-wc recommendations.          |
+| [testing-wallaby](./packages/testing-wallaby)                       | [![testing-wallaby](https://img.shields.io/npm/v/@open-wc/testing-wallaby.svg)](https://www.npmjs.com/package/@open-wc/testing-wallaby)                                  | Testing with wallaby following open-wc recommendations.                           |
+| [webpack-import-meta-loader](./packages/webpack-import-meta-loader) | [![webpack-import-meta-loader](https://img.shields.io/npm/v/@open-wc/webpack-import-meta-loader.svg)](https://www.npmjs.com/package/@open-wc/webpack-import-meta-loader) | Webpack loader plugin to support import.meta.                                     |
 
 ## Contact
+
 Feel free to reach out to us on [twitter](https://twitter.com/OpenWc) or create [a github issue](https://github.com/open-wc/open-wc/issues/new) for any feedback or questions you might have.
 
 You can also find us on the Polymer slack in the [#open-wc](https://polymer.slack.com/messages/CE6D9DN05) channel.
 
 You can join the Polymer slack by visiting [https://www.polymer-project.org/slack-invite](https://www.polymer-project.org/slack-invite).
 
-
 ## We Proudly Use
+
 <a href="http://browserstack.com/" style="border: none;"><img src="https://github.com/open-wc/open-wc/blob/master/assets/images/Browserstack-logo.svg" width="200" alt="Browserstack Logo" /></a>
 
 <a href="http://netlify.com/" style="border: none;"><img src="https://www.netlify.com/img/press/logos/full-logo-light.svg" width="185" alt="netlify logo" /></a>
 
-
 ## Guide
+
 ```bash
 # bootstrap/setup
 yarn install

diff --git a/docs/README.md b/docs/README.md
@@ -4,14 +4,15 @@ heroImage: /hero.png
 actionText: Get Started →
 actionLink: /guide/
 features:
-- title: Smart Defaults
-  details: Enjoy the peace of mind that comes from having a well-known default solution for almost everything. From linting to testing to demos to publishing - have the full experience.
-- title: Awesome Generators
-  details: Get up and running quickly with opinionated generators, or add recommended tools to existing projects. Our comprehensive fleet of generators have got you covered.
-- title: Open Source Love
-  details: Open Web Components is a community-effort, independent of any framework or company. We use mostly open-source tools and services. 
+  - title: Smart Defaults
+    details: Enjoy the peace of mind that comes from having a well-known default solution for almost everything. From linting to testing to demos to publishing - have the full experience.
+  - title: Awesome Generators
+    details: Get up and running quickly with opinionated generators, or add recommended tools to existing projects. Our comprehensive fleet of generators have got you covered.
+  - title: Open Source Love
+    details: Open Web Components is a community-effort, independent of any framework or company. We use mostly open-source tools and services.
 footer: MIT Licensed | Copyright © 2018-2019 open-wc
 ---
+
 <hr>
 <p align="center" style="margin: 50px; color: #4e6e8e;">
   <q><i>I used open-wc to get testing working, it was so helpful, works like a charm!</i></q>

diff --git a/docs/about/README.md b/docs/about/README.md
@@ -23,7 +23,7 @@ Many web developers have experienced the dreaded "Javascript Fatigue". With our
 
 We want web component development to be accessible and approachable for everyone, regardless of their background. Therefore, our recommendations aim to be easy to use, be ready to use, and provide that "it just works" developer experience we all crave for the various aspects of web component development.
 
-Best practices/recommendations and examples may change and evolve over time.	
+Best practices/recommendations and examples may change and evolve over time.
 
 ### Why Web Components
 
@@ -46,12 +46,15 @@ What if you could remove code, gain performance, and streamline implementation a
 - Write using a streamlined component API that combines the best bits of popular libraries and frameworks!
 
 ##### Performance
+
 Just like `querySelector` reduces developers' dependence on jQuery, the web components standards reduces the size and complexity of component libraries and frameworks. This ultimately benefits users by decreasing page load times and increasing app performance.
 
 ##### Future Proofing
+
 Using the browser's standards-based component model will increase the longevity of your application. The web has an extremely strong tradition of backwards-compatibility. Standards bodies have consistently gone out of their way to maintain legacy APIs.
 
 ##### Flexibility
+
 The web components standards are fairly low-level, letting library authors build upon them with innovative APIs. By using such libraries you can build your app in the style you want while still leveraging built-in browser features.
 
 ## Contribute

diff --git a/docs/about/blog.md b/docs/about/blog.md
@@ -1,21 +1,21 @@
 # Blog
 
-## [Announcing Open Web Components](https://dev.to/thepassle/announcing-open-web-components-5h7) 
+## [Announcing Open Web Components](https://dev.to/thepassle/announcing-open-web-components-5h7)
 
 by [open-wc](https://github.com/open-wc)
 
-## [Cross Browser Testing your Stencil Web Component like a boss](https://medium.com/vincent-ogloblinsky/cross-browser-testing-your-stencil-web-component-like-a-boss-93c1b154bfd9) 
+## [Cross Browser Testing your Stencil Web Component like a boss](https://medium.com/vincent-ogloblinsky/cross-browser-testing-your-stencil-web-component-like-a-boss-93c1b154bfd9)
 
 by [Vincent Ogloblinsky](https://github.com/vogloblinsky)
 
 ## [npm Convos: open-wc](https://blog.npmjs.org/post/182917093835/npm-convos-open-wc?utm_campaign=newsletter20190228&utm_source=newsletter_mailer&utm_medium=email&utm_source=npm+Weekly&utm_campaign=72f3f1c998-npm_weekly_186_2019_02_26_08_58&utm_medium=email&utm_term=0_e17fe5d778-72f3f1c998-303236901)
 
 by [npm](npmjs.com)
 
-## [Not Another To Do App](https://medium.com/@westbrook/not-another-to-do-app-169c14bb7ef9) 
+## [Not Another To Do App](https://medium.com/@westbrook/not-another-to-do-app-169c14bb7ef9)
 
 by [Westbrook Johnson](https://github.com/westbrook)
 
-## [Web Components: spoils of the browser wars](https://www.andrewzigler.com/blog/2019/02/28/web-components-spoils-of-the-browser-wars/) 
+## [Web Components: spoils of the browser wars](https://www.andrewzigler.com/blog/2019/02/28/web-components-spoils-of-the-browser-wars/)
 
 by [Andrew Zigler](https://github.com/azigler)
diff --git a/docs/about/rationales.md b/docs/about/rationales.md
@@ -10,7 +10,6 @@ This is such a powerful and widely-used pattern in the current JavaScript ecosys
 We want to help you build your apps as easily and efficiently as possible, so for now we've adopted this practice as our only exception to the above rules.
 The [import maps](https://github.com/WICG/import-maps) proposal aims to bring bare modules to the web browser. You can follow that repository to stay up to date.
 
-
 ## Workflows
 
 We recommend implementing the following three workflows for specific tasks while developing your component or application.
@@ -26,9 +25,11 @@ We recommend our [ES Dev Server](../developing/es-dev-server.html) as it does no
 :::
 
 When would you choose this workflow:
+
 - When developing new features
 
 Why would you choose this:
+
 - Simple to setup
 - As fast as it gets
 
@@ -38,28 +39,31 @@ Chances are that the web components you're building will need to run in more tha
 In these cases it's time to open your toolbox and make sure everything works in all supported browsers.
 
 When would you choose this workflow:
+
 - To verify everything works in all supported browsers
 - To debug legacy browsers
 
 We recommend our [Open Web Components Building Setup](../building).
 
 Why would you choose it:
+
 - As good as it gets when you need to work with legacy browsers
 - Auto-bundling/reloading
 
-
 ### Production Workflow
 
 Once you're happy with your web components, it's time to put them somewhere more useful.
 Most likely a publicly available web server.
 Before you do that let's apply all the optimizations magic we can cook up.
 
 When would you use this:
+
 - Optimize your build
 - Publishing to production
 
 We recommend our [Open Web Components Building Setup](../building).
 
 Why would you choose it:
+
 - Multiple bundles for differential serving
 - Conditional auto-loader for those bundles (without a special server)