@turquoisehealth/pit-viper 2.0.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/_site/assets/css/pit-viper-v2.css +4858 -0
- package/_site/assets/css/pit-viper.css +4875 -0
- package/_site/assets/js/pit-viper.js +180 -0
- package/_src/assets/sprite-v2.svg +1 -0
- package/_src/assets/sprite.svg +1 -0
- package/package.json +74 -0
- package/pv-components/dist/vue/base/pv-components-base.d.mts +179 -0
- package/pv-components/dist/vue/base/pv-components-base.mjs +3182 -0
- package/pv-components/dist/vue/tables/pv-components-tables.d.mts +74 -0
- package/pv-components/dist/vue/tables/pv-components-tables.mjs +39355 -0
- package/pv-components/dist/web/index.d.ts +1 -0
- package/pv-components/dist/web/pv-components.iife.js +90 -0
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
[](https://app.netlify.com/sites/thds/deploys)
|
|
2
|
+
|
|
3
|
+
## Pit Viper
|
|
4
|
+
|
|
5
|
+
Documentation and CSS framework for Turquoise Health's design system, [Pit Viper](https://pitviper.turquoise.health).
|
|
6
|
+
|
|
7
|
+
### Running Pit Viper Locally
|
|
8
|
+
1. Clone this repo.
|
|
9
|
+
2. Run `npm install` to install all necessary packages.
|
|
10
|
+
3. Run `npm run start` and you should see Pit Viper in http://localhost:8080/. Any updates will automatically update and refresh in the browser.
|
|
11
|
+
|
|
12
|
+
To develop locally with the Turquoise Health site, read the [Notion documentation](https://www.notion.so/turquoisehealth/Develop-w-Pit-Viper-Locally-f2c2ce234c934525a18172504f704080).
|
|
13
|
+
|
|
14
|
+
### Applying Pit Viper
|
|
15
|
+
|
|
16
|
+
#### Install as an npm package
|
|
17
|
+
|
|
18
|
+
```html
|
|
19
|
+
npm install th-pit-viper
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
The package includes the following files:
|
|
23
|
+
|
|
24
|
+
* `_site/assets/css/pit-viper.css`
|
|
25
|
+
* `_src/assets/sprite.svg`
|
|
26
|
+
|
|
27
|
+
Add `pit-viper.css` in the `<head>` of a page:
|
|
28
|
+
|
|
29
|
+
```html
|
|
30
|
+
<link rel="stylesheet" href="[path]/pit-viper.css">
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Add the contents of `sprite.svg` in the `<body>` of a page:
|
|
34
|
+
|
|
35
|
+
```html
|
|
36
|
+
<div hidden>[include sprite.svg here]</div>
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
#### Use as a CodePen template
|
|
40
|
+
|
|
41
|
+
You can use the template below to start a new pen that pulls in the latest version of `pit-viper.css` so you can start prototyping quickly without writing CSS.
|
|
42
|
+
|
|
43
|
+
* [CodePen Template](https://codepen.io/pen?template=YzOOoYz)
|
|
44
|
+
|
|
45
|
+
### Support
|
|
46
|
+
|
|
47
|
+
* #design-system channel in Slack
|
|
48
|
+
* Office Hours, every Wednesday from 11am-Noon Pacific (contact [Mike Aparicio](mailto:mike.aparicio@turquoise.health) for an invite)
|
|
49
|
+
* [Submit an issue](https://github.com/turquoisehealth/pit-viper/issues) in this Github repo
|
|
50
|
+
|