Skip to content

Commit

Permalink
fix: update markdown partial pathing to consume new auro lib #42
Browse files Browse the repository at this point in the history
  • Loading branch information
@sun-mota
sun-mota committed Nov 11, 2024
1 parent dd3f94c commit 43957f1
Show file tree
Hide file tree
Showing 10 changed files with 417 additions and 189 deletions.
26 changes: 13 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The README.md file is a compiled document. No edits should be made directly to t
README.md is created by running `npm run build:docs`.
This file is generated based on a template fetched from
`https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README.md`
`https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_updated_paths.md`
and copied to `./componentDocs/README.md` each time the the docs are compiled.
The following sections are editable by making changes to the following files:
Expand All @@ -19,12 +19,12 @@ The following sections are editable by making changes to the following files:

# Lockup

<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) -->
<!-- The below content is automatically added from ./../docs/partials/description.md -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
<!-- The below content is automatically added from ./docs/partials/description.md -->
The `auro-lockup` HTML custom element is a standardized use case element for authorized Alaska Airlines extended experiences.
<!-- AURO-GENERATED-CONTENT:END -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/readmeAddlInfo.md) -->
<!-- The below content is automatically added from ./../docs/partials/readmeAddlInfo.md -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
<!-- AURO-GENERATED-CONTENT This file is to be used for any additional content that should be included in the README.md which is specific to this component. -->
<!-- AURO-GENERATED-CONTENT:END -->

Expand Down Expand Up @@ -72,8 +72,8 @@ import "@aurodesignsystem/auro-lockup";

<!-- AURO-GENERATED-CONTENT:END -->
**Reference component in HTML**
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
<!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->

```html
<auro-lockup>
Expand All @@ -98,16 +98,16 @@ In cases where the project is not able to process JS assets, there are pre-proce

```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/[email protected]/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@6.0.0/dist/bundled/essentials.css" />
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-lockup@4.0.1/dist/auro-lockup__bundled.js" type="module"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@5.1.2/dist/bundled/essentials.css" />
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-lockup@4.1.1/dist/auro-lockup__bundled.js" type="module"></script>
```

<!-- AURO-GENERATED-CONTENT:END -->

## auro-lockup use cases

<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/useCases.md) -->
<!-- The below content is automatically added from ./../docs/partials/useCases.md -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
<!-- The below content is automatically added from ./docs/partials/useCases.md -->
The `auro-lockup` use cases include:

* Product lines
Expand All @@ -119,8 +119,8 @@ The `auro-lockup` use cases include:

### Default auro-lockup

<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
<!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->

```html
<auro-lockup>
Expand Down
56 changes: 28 additions & 28 deletions demo/api.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../api.md) -->
<!-- The below content is automatically added from ./../api.md -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../docs/api.md) -->
<!-- The below content is automatically added from ../docs/api.md -->

# auro-lockup

Expand Down Expand Up @@ -37,15 +37,15 @@ See the following examples for use-case illustrations of API options.
Use the `onDark` attribute for the proper presentation on a darker background.

<div class="exampleWrapper--ondark">
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/onDarkExample.html) -->
<!-- The below content is automatically added from ./../../apiExamples/onDarkExample.html -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/onDarkExample.html) -->
<!-- The below content is automatically added from ../apiExamples/onDarkExample.html -->
<auro-lockup onDark></auro-lockup>
<!-- AURO-GENERATED-CONTENT:END -->
</div>
<auro-accordion alignRight>
<span slot="trigger">See code</span>
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/onDarkExample.html) -->
<!-- The below code snippet is automatically added from ./../../apiExamples/onDarkExample.html -->
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/onDarkExample.html) -->
<!-- The below code snippet is automatically added from ../apiExamples/onDarkExample.html -->

```html
<auro-lockup onDark></auro-lockup>
Expand All @@ -59,15 +59,15 @@ Use the `onDark` attribute for the proper presentation on a darker background.
Use the `oneWorld` property to replace the product name and tag line with one**World** logo.

<div class="exampleWrapper">
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/oneWorld.html) -->
<!-- The below content is automatically added from ./../../apiExamples/oneWorld.html -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/oneWorld.html) -->
<!-- The below content is automatically added from ../apiExamples/oneWorld.html -->
<auro-lockup oneworld></auro-lockup>
<!-- AURO-GENERATED-CONTENT:END -->
</div>
<auro-accordion alignRight>
<span slot="trigger">See code</span>
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/oneWorld.html) -->
<!-- The below code snippet is automatically added from ./../../apiExamples/oneWorld.html -->
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/oneWorld.html) -->
<!-- The below code snippet is automatically added from ../apiExamples/oneWorld.html -->

```html
<auro-lockup oneworld></auro-lockup>
Expand All @@ -79,15 +79,15 @@ Use the `oneWorld` property to replace the product name and tag line with one**W
Use the `path` property to add a custom URL reference to the clickable lockup. A `/` is set by default.

<div class="exampleWrapper">
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/path.html) -->
<!-- The below content is automatically added from ./../../apiExamples/path.html -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/path.html) -->
<!-- The below content is automatically added from ../apiExamples/path.html -->
<auro-lockup path="https://www.alaskaair.com"></auro-lockup>
<!-- AURO-GENERATED-CONTENT:END -->
</div>
<auro-accordion alignRight>
<span slot="trigger">See code</span>
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/path.html) -->
<!-- The below code snippet is automatically added from ./../../apiExamples/path.html -->
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/path.html) -->
<!-- The below code snippet is automatically added from ../apiExamples/path.html -->

```html
<auro-lockup path="https://www.alaskaair.com"></auro-lockup>
Expand All @@ -99,15 +99,15 @@ Use the `path` property to add a custom URL reference to the clickable lockup. A
Use the `standard` property to use the standard Alaska logo in place of the official logo. Restricted to use with the one**World** logo.

<div class="exampleWrapper">
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/standard.html) -->
<!-- The below content is automatically added from ./../../apiExamples/standard.html -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/standard.html) -->
<!-- The below content is automatically added from ../apiExamples/standard.html -->
<auro-lockup standard oneWorld></auro-lockup>
<!-- AURO-GENERATED-CONTENT:END -->
</div>
<auro-accordion alignRight>
<span slot="trigger">See code</span>
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/standard.html) -->
<!-- The below code snippet is automatically added from ./../../apiExamples/standard.html -->
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/standard.html) -->
<!-- The below code snippet is automatically added from ../apiExamples/standard.html -->

```html
<auro-lockup standard oneWorld></auro-lockup>
Expand All @@ -121,17 +121,17 @@ Use the `standard` property to use the standard Alaska logo in place of the offi
Usd the `title` slot to add lockup content.

<div class="exampleWrapper">
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/title.html) -->
<!-- The below content is automatically added from ./../../apiExamples/title.html -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/title.html) -->
<!-- The below content is automatically added from ../apiExamples/title.html -->
<auro-lockup>
<span slot="title">Product Name</span>
</auro-lockup>
<!-- AURO-GENERATED-CONTENT:END -->
</div>
<auro-accordion alignRight>
<span slot="trigger">See code</span>
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/title.html) -->
<!-- The below code snippet is automatically added from ./../../apiExamples/title.html -->
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/title.html) -->
<!-- The below code snippet is automatically added from ../apiExamples/title.html -->

```html
<auro-lockup>
Expand All @@ -145,17 +145,17 @@ Usd the `title` slot to add lockup content.
Usd the `subtitle` slot to add lockup content.

<div class="exampleWrapper">
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../apiExamples/subtitle.html) -->
<!-- The below content is automatically added from ./../../apiExamples/subtitle.html -->
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/subtitle.html) -->
<!-- The below content is automatically added from ../apiExamples/subtitle.html -->
<auro-lockup>
<span slot="subtitle">Powered by Partner Name</span>
</auro-lockup>
<!-- AURO-GENERATED-CONTENT:END -->
</div>
<auro-accordion alignRight>
<span slot="trigger">See code</span>
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../apiExamples/subtitle.html) -->
<!-- The below code snippet is automatically added from ./../../apiExamples/subtitle.html -->
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/subtitle.html) -->
<!-- The below code snippet is automatically added from ../apiExamples/subtitle.html -->

```html
<auro-lockup>
Expand All @@ -169,8 +169,8 @@ Usd the `subtitle` slot to add lockup content.

The component may be restyled using the following code sample and changing the values of the following token(s).

<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../src/tokens.scss) -->
<!-- The below code snippet is automatically added from ./../../src/tokens.scss -->
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../src/tokens.scss) -->
<!-- The below code snippet is automatically added from ../src/tokens.scss -->

```scss
@import './../node_modules/@aurodesignsystem/design-tokens/dist/tokens/SCSSVariables';
Expand Down
Loading

0 comments on commit 43957f1

Please sign in to comment.