From 4a4702d476ee736a84bf5ef71be2da0faec5b90a Mon Sep 17 00:00:00 2001 From: Eunsun Mota Date: Fri, 8 Nov 2024 17:06:17 -0500 Subject: [PATCH] fix: update markdown partial pathing to consume new auro lib #48 --- README.md | 22 ++++---- demo/api.md | 112 +++++++++++++++++++-------------------- demo/api.min.js | 117 ++++++++++++++++++++++++++++++++++++----- demo/index.md | 64 +++++++++++----------- demo/index.min.js | 117 ++++++++++++++++++++++++++++++++++++----- docs/partials/api.md | 56 ++++++++++---------- docs/partials/index.md | 32 +++++------ package-lock.json | 19 +++---- package.json | 2 +- rollup.config.mjs | 6 ++- 10 files changed, 365 insertions(+), 182 deletions(-) diff --git a/README.md b/README.md index 424a2c6..cd95a6e 100644 --- a/README.md +++ b/README.md @@ -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: @@ -19,8 +19,8 @@ The following sections are editable by making changes to the following files: # Loader - - + + `` is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of illustrating animated loaders. Things take time. Sometimes we just need to take a second for some data to show up. For this Auro supports the `` custom element. This powerful element supports multiple modes for use, `ringworm`, `orbit`, `pulse`, and `laser`. @@ -31,8 +31,8 @@ For color support `` supports `currentColor`, this allows for any c The `` custom element also supports three pre-defined color modes, `onlight`, `ondark` and `white`. - - + + @@ -80,8 +80,8 @@ import "@aurodesignsystem/auro-loader"; **Reference component in HTML** - - + + ```html @@ -114,8 +114,8 @@ In cases where the project is not able to process JS assets, there are pre-proce ## auro-loader use cases - - + + The `` element should be used in situations where developers may need to illustrate a wait time for their users. @@ -123,8 +123,8 @@ The `` element should be used in situations where developers may ne ### Default auro-loader - - + + ```html diff --git a/demo/api.md b/demo/api.md index cdb8ab6..dc57d72 100644 --- a/demo/api.md +++ b/demo/api.md @@ -1,5 +1,5 @@ - - + + # auro-loader @@ -40,8 +40,8 @@ The auro-loader element is an easy to use animated loader component. The following illustrates the use of the base elements with default output. The `laser` example is shown at the top of the page due to its fixed positioning.
- - + + @@ -50,8 +50,8 @@ The following illustrates the use of the base elements with default output. The
See code - - + + ```html @@ -68,8 +68,8 @@ The following illustrates the use of the base elements with default output. The Use the `xs` boolean attribute for a pre-defined size. Type `laser` does not support a size attribute.
- - + + @@ -77,8 +77,8 @@ Use the `xs` boolean attribute for a pre-defined size. Type `laser` does not sup
See code - - + + ```html @@ -92,8 +92,8 @@ Use the `xs` boolean attribute for a pre-defined size. Type `laser` does not sup Use the `sm` boolean attribute for a pre-defined size. Type `laser` does not support a size attribute.
- - + + @@ -101,8 +101,8 @@ Use the `sm` boolean attribute for a pre-defined size. Type `laser` does not sup
See code - - + + ```html @@ -116,8 +116,8 @@ Use the `sm` boolean attribute for a pre-defined size. Type `laser` does not sup Use the `md` boolean attribute for a pre-defined size. Type `laser` does not support a size attribute.
- - + + @@ -125,8 +125,8 @@ Use the `md` boolean attribute for a pre-defined size. Type `laser` does not sup
See code - - + + ```html @@ -140,8 +140,8 @@ Use the `md` boolean attribute for a pre-defined size. Type `laser` does not sup Use the `lg` boolean attribute for a pre-defined size. Type `laser` does not support a size attribute.
- - + + @@ -149,8 +149,8 @@ Use the `lg` boolean attribute for a pre-defined size. Type `laser` does not sup
See code - - + + ```html @@ -164,8 +164,8 @@ Use the `lg` boolean attribute for a pre-defined size. Type `laser` does not sup Use the `onlight` boolean attribute for a pre-defined color. Type `laser` is supported, but not shown due to fixed positioning.
- - + + @@ -173,8 +173,8 @@ Use the `onlight` boolean attribute for a pre-defined color. Type `laser` is sup
See code - - + + ```html @@ -188,8 +188,8 @@ Use the `onlight` boolean attribute for a pre-defined color. Type `laser` is sup Use the `ondark` boolean attribute for a pre-defined color. Type `laser` is supported, but not shown due to fixed positioning.
- - + + @@ -197,8 +197,8 @@ Use the `ondark` boolean attribute for a pre-defined color. Type `laser` is supp
See code - - + + ```html @@ -212,8 +212,8 @@ Use the `ondark` boolean attribute for a pre-defined color. Type `laser` is supp Use the `white` boolean attribute for a pre-defined color. Type `laser` is supported, but not shown due to fixed positioning.
- - + + @@ -221,8 +221,8 @@ Use the `white` boolean attribute for a pre-defined color. Type `laser` is suppo
See code - - + + ```html @@ -240,15 +240,15 @@ Use the following `orbit`, `laser`, `ringworm`, and `pulse` properties as illust Use the `orbit` property for the desired animated loader.
- - + +
See code - - + + ```html @@ -260,15 +260,15 @@ Use the `orbit` property for the desired animated loader. Use the `laser` property for the desired animated loader. Example is shown at the top of the page due its fixed positioning.
- - + +
See code - - + + ```html @@ -280,15 +280,15 @@ Use the `laser` property for the desired animated loader. Example is shown at th Use the `pulse` property for the desired animated loader.
- - + +
See code - - + + ```html @@ -300,15 +300,15 @@ Use the `pulse` property for the desired animated loader. Use the `ringworm` property for the desired animated loader.
- - + +
See code - - + + ```html @@ -322,8 +322,8 @@ Use the `ringworm` property for the desired animated loader. Use the `element` CSS Part with your CSS as illustrated to effect things like the speed of the animation.
- - + +