Skip to content

Commit

Permalink
Add "prod" directory type to README
Browse files Browse the repository at this point in the history
  • Loading branch information
rshiggin authored Jul 24, 2023
1 parent f03c570 commit e05e8ae
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
## Rivet components for IUL
### Lightweight set of assets for specific components (HTML, CSS, JS) adapted from IU's Rivet Design System. Use to install up-to-date branding and other Rivet-based components in already exising applications.
### Rivet components for IUL
##### Lightweight set of assets for specific components (HTML, CSS, JS) adapted from IU's Rivet Design System. Use to install up-to-date branding and other Rivet-based components in already exising applications.

#### Installation
In most cases do not use Rivet-provided CDN URLs for CSS & JS. This will risk collision with other elements in your application.
#### DIST directory
- Use **"dist" components** for plug-n-play HTML (more components will be added as needed)
- Add relevant "css" file to your application's "head". This CSS uses a "rvt" prefix on classes and is designed so that it will NOT override any other application components.
- Add Rivet javascript to your code (usually just before the closing "body" tag). Be sure to include 'Rivet.init' as shown.
```
<script src="local/path/to/javascript/rivet-header.min.js"></script>
<script>Rivet.init();</script>
```
In most cases do not use Rivet-provided CDN URLs for CSS & JS. This will risk collision with other elements in your application.

#### For an interactive view of seperate components, see https://rivet.iu.edu/components/
##### For an interactive view of seperate components, see https://rivet.iu.edu/components/
- Header https://rivet.iu.edu/components/header/
- Footer https://rivet.iu.edu/components/footer/
- Card https://rivet.iu.edu/components/card/
- Tabs https://rivet.iu.edu/components/tabs/

#### Fonts
##### Fonts
- UPDATE: each stylesheet includes IU spec fonts

#### Examples of build details using NPM 'rivet-source' SASS
##### Examples of build details using NPM 'rivet-source' SASS
NPM package at https://www.npmjs.com/package/rivet-core
```
// header.css compiled from
Expand All @@ -40,7 +40,7 @@ NPM package at https://www.npmjs.com/package/rivet-core
@use 'grid';
```
#### Examples of build details using NPM 'rivet-source' JS
##### Examples of build details using NPM 'rivet-source' JS
Download and NPM install https://github.com/indiana-university/rivet-source
```
// header-rivet.min.js
Expand All @@ -52,7 +52,9 @@ import Disclosure from './components/disclosure'
import Dropdown from './components/dropdown'
import Sidenav from './components/sidenav'
```
#### PROD directory
Dist components (e.g., header, footer) with prepopulated links and content to be used as "universal" branding components across IUL websites.

#### Source
#### SRC directory
- "src" is a clone of source files from the active Rivet repository https://github.com/indiana-university/rivet-source/
- uncompiled javascript, for example, can be found in '/src/js/components'

0 comments on commit e05e8ae

Please sign in to comment.