Skip to content

Commit a467caa

Browse files
committed
make documentation adhere to style guide
1 parent 086c586 commit a467caa

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

storybook/framework-guidance.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import VueExample from "../examples/with-vue/src/App.vue?raw";
1111

1212
# Framework-specific Guidance
1313

14-
We have made every effort to make using USWDS Elements in your project as easy as possible. Since many projects use modern front-end libraries and frameworks, we have included an example directory in this repository that shows minimal examples of how to import and use USWDS Elements with a variety of popular front-end technologies. The goal is to provide an experience that involves minimal configuration to get up and running with your framework or library of choice.
14+
We've made every effort to make using USWDS Elements in your project as easy as possible. Since many projects use modern front-end libraries and frameworks, we've included an [examples directory](https://github.com/uswds/uswds-elements/tree/develop/examples) in this repository that shows how to import and use USWDS Elements with a variety of popular front-end technologies. The goal is to provide an experience that involves minimal configuration to get up and running with your framework or library of choice.
1515

1616
In all cases, install the project from the npm package registry.
1717

@@ -23,7 +23,7 @@ $ npm install @uswds/elements
2323

2424
### HTML
2525

26-
To use a specific element directly in an HTML page, use the code snippet below. This example also applies if you are using USWDS Elements in a CMS that has its own templating engine (e.g. Drupal, WordPress, etc.).
26+
To use a specific element directly in an HTML page, use the code snippet below. This example also applies if you're using USWDS Elements in a CMS that has its own templating engine (e.g. Drupal, WordPress, etc.).
2727

2828
```html
2929
<!-- importing directly into an HTML page -->
@@ -53,7 +53,7 @@ This is a minimal example of implementation in [SolidJS](https://www.solidjs.com
5353

5454
#### TypeScript support
5555

56-
If you are using TypeScript for your SolidJS project, add a `custom-elements.d.ts` file to `src/` directory.
56+
If you're using TypeScript for your SolidJS project, add a `custom-elements.d.ts` file to `src/` directory.
5757

5858
<Source code={SolidDTsExample} language="ts" />
5959

@@ -73,7 +73,7 @@ This is a minimal example of implementation in [Vue](https://vuejs.org/).
7373

7474
<Source code={VueExample} language="vue" />
7575

76-
Additionally, your build tool needs to know about the custom elements so they are not parsed at build time. This is how you do it in Vite:
76+
Additionally, your build tool needs to know about the custom elements so they aren't parsed at build time. This is how you do it in Vite:
7777

7878
```
7979
// vite.config.ts

0 commit comments

Comments
 (0)