Skip to content

Commit

Permalink
docs(QUICKSTART): and reference in README
Browse files Browse the repository at this point in the history
  • Loading branch information
wesleyboar committed Mar 28, 2024
1 parent 9e06803 commit a90a029
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 2 deletions.
39 changes: 39 additions & 0 deletions QUICKSTART.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Quick Start

Core-Styles is reusable CSS used by [TACC].

## Basic Usage

For a static website:

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tacc/core-styles@2.25.3/dist/core-styles.base.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tacc/core-styles@2.25.3/dist/core-styles.cms.css" />
```

For a dynamic web application:

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tacc/core-styles@2.25.3/dist/core-styles.base.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tacc/core-styles@2.25.3/dist/core-styles.portal.css" />
```

For just [custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/--*) e.g. colors, size, spacing, et cetera:

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tacc/core-styles@2.25.3/dist/core-styles.base.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tacc/core-styles@2.25.3/dist/core-styles.portal.css" />
```

> [!TIP]
> For UI patterns and demos, see https://tacc.utexas.edu/static/ui/.
> [!NOTE]
> For a more-detailed walkthrough and options, see [../HOWTO.md](../HOWTO.md).
## Advanced Usage

[Install into a Project via Node.](README.md#b-install-into-a-project)

[Node.js]: https://nodejs.org/
[TACC]: https://www.tacc.utexas.edu/
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ The shared styles for TACC WMA Workspace Portals & Websites

### A. Load from a Project

> **Note**
> [!NOTE]
> This is likely the easier and simpler solution. Try this first.
See [`HOWTO.md`](HOWTO.md).
See [`QUICKSTART.md`](QUICKSTART.md).

### B. Install into a Project

Expand Down

0 comments on commit a90a029

Please sign in to comment.