summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2025-06-12 20:10:20 +0300
committerPatrick Williams <patrick@stwcx.xyz>2025-06-12 20:10:20 +0300
commit5fa63e5a5ff1e97ea7303cf8da9d74e45685a66e (patch)
tree0455e50263b47e79bbe4f4417303e18be0c22857 /docs/guide
parent7fb9bb4f60eef821fb3964888a25cbc4e4e54718 (diff)
downloadwebui-vue-master.tar.xz
markdownlint: fixesHEADmaster
Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: I5d07d550b9c483de6c4d5f64570ea8336564297a
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/components/buttons/index.md6
-rw-r--r--docs/guide/components/file-upload/readme.md2
-rw-r--r--docs/guide/components/table/index.md4
-rw-r--r--docs/guide/components/toasts/index.md5
-rw-r--r--docs/guide/guidelines/colors.md14
-rw-r--r--docs/guide/guidelines/motion.md4
-rw-r--r--docs/guide/unit-testing/readme.md4
7 files changed, 19 insertions, 20 deletions
diff --git a/docs/guide/components/buttons/index.md b/docs/guide/components/buttons/index.md
index 251316ff9..9a4ed658c 100644
--- a/docs/guide/components/buttons/index.md
+++ b/docs/guide/components/buttons/index.md
@@ -8,12 +8,12 @@ like a link, set the variant value to `link`.
[Learn more about Bootstrap-vue buttons](https://bootstrap-vue.js.org/docs/components/button)
-### Icon only buttons
+## Icon only buttons
Add `btn-icon-only` class to the button and add `title` attribute to get helper
text on hover over the button.
-### Enabled buttons
+## Enabled buttons
![Button examples](./button.png)
@@ -36,7 +36,7 @@ text on hover over the button.
</b-button>
```
-### Disabled buttons
+## Disabled buttons
![Disabled button examples](./button-disabled.png)
diff --git a/docs/guide/components/file-upload/readme.md b/docs/guide/components/file-upload/readme.md
index e0819a85a..3a2d5ea2a 100644
--- a/docs/guide/components/file-upload/readme.md
+++ b/docs/guide/components/file-upload/readme.md
@@ -11,7 +11,7 @@ To use this component:
[Learn more about the Bootstrap-vue Form File component](https://bootstrap-vue.org/docs/components/form-file)
-### Optional properties
+## Optional properties
- `id`- Used to set the `id` attribute on the rendered content, and used as the
base to generate any additional element IDs as needed
diff --git a/docs/guide/components/table/index.md b/docs/guide/components/table/index.md
index 47bc51d86..03df43e27 100644
--- a/docs/guide/components/table/index.md
+++ b/docs/guide/components/table/index.md
@@ -379,7 +379,7 @@ export default {
To add a table dropdown filter:
-1. Import the `<table-filter> `component and TableFilterMixin.
+1. Import the `<table-filter>` component and `TableFilterMixin`.
1. Add a filters prop to the `<table-filters>` component. This prop should be an
array of filter groups–each required to have a key, label, and values prop.
@@ -458,7 +458,7 @@ once.
To add table batch actions:
-1. Import the `<table-toolbar> `component and BVTableSelectableMixin
+1. Import the `<table-toolbar>` component and `BVTableSelectableMixin`
1. Add the `selectable`, `no-select-on-click` props and a unique `ref` to the
table. The table will emit a `@row-selected` event. Use the `onRowSelected`
mixin method as a callback and provide the `$event` as the first argument and
diff --git a/docs/guide/components/toasts/index.md b/docs/guide/components/toasts/index.md
index b19643de9..94ebaf685 100644
--- a/docs/guide/components/toasts/index.md
+++ b/docs/guide/components/toasts/index.md
@@ -11,7 +11,7 @@ message will auto-hide after 10 seconds. The user must manually dismiss the
provides a simple API that generates a toast message that meets the transition
guidelines.
-<img src="./toast.png" alt="Toast message examples" style="max-width:350px">
+![Toast message examples](toast.png)
```js{5}
// Sample method from Reboot BMC page
@@ -51,8 +51,7 @@ object with a `title` property to change the default toast title. Include a
application. Include a `timestamp` property, set to true, to include a timestamp
in the toast.
-<img src="./toast-options.png" alt="Toast message options example"
-style="max-width:350px">
+![Toast message options example](toast-options.png)
```js
diff --git a/docs/guide/guidelines/colors.md b/docs/guide/guidelines/colors.md
index 6ddcfeee6..4312bf432 100644
--- a/docs/guide/guidelines/colors.md
+++ b/docs/guide/guidelines/colors.md
@@ -13,23 +13,23 @@ colors to override default styles set by the Bootstrap library.
## Grays
-<colors-grays/>
+`<colors-grays/>`
## Blues
-<colors-blues/>
+`<colors-blues/>`
## Greens
-<colors-greens/>
+`<colors-greens/>`
## Reds
-<colors-reds/>
+`<colors-reds/>`
## Yellows
-<colors-yellows/>
+`<colors-yellows/>`
## All Colors
@@ -38,7 +38,7 @@ colors to override default styles set by the Bootstrap library.
`theme-colors` map colors.
[Learn more about the Bootstrap color maps](https://getbootstrap.com/docs/4.0/getting-started/theming/#all-colors).
-<colors-all/>
+`<colors-all/>`
## Theme Colors
@@ -48,4 +48,4 @@ component.
[Learn more about the Bootstrap theme-colors maps](https://getbootstrap.com/docs/4.0/getting-started/theming/#theme-colors).
-<colors-theme/>
+`<colors-theme/>`
diff --git a/docs/guide/guidelines/motion.md b/docs/guide/guidelines/motion.md
index 8ec9f5b7f..2f0564def 100644
--- a/docs/guide/guidelines/motion.md
+++ b/docs/guide/guidelines/motion.md
@@ -23,7 +23,7 @@ for expressive motion.
### Easing tokens
-```
+```css
$standard-easing--productive: cubic-bezier(0.2, 0, 0.38, 0.9);
$standard-easing--expressive: cubic-bezier(0.4, 0.14, 0.3, 1);
$entrance-easing--productive: cubic-bezier(0, 0, 0.38, 0.9);
@@ -42,7 +42,7 @@ longer the animation takes.
### Duration tokens
-```
+```css
$duration--fast-01: 70ms; //Micro-interactions such as button and toggle
$duration--fast-02: 110ms; //Micro-interactions such as fade
$duration--moderate-01: 150ms; //Micro-interactions, small expansion, short distance movements
diff --git a/docs/guide/unit-testing/readme.md b/docs/guide/unit-testing/readme.md
index 761837686..fe879f745 100644
--- a/docs/guide/unit-testing/readme.md
+++ b/docs/guide/unit-testing/readme.md
@@ -10,8 +10,8 @@ the internals of the component.
> not too few, but just enough. Thousands of tests for a small application can
> be as damaging to development time as no tests.
>
-> -- <cite>Ed Yerburgh, Testing Vue Applications (New York: Manning
-> Publications, 2019)</cite>
+> -- Ed Yerburgh, Testing Vue Applications (New York: Manning
+> Publications, 2019)
## Test Libraries