Skip to content

Commit 036ef9c

Browse files
committed
docs: update documentation
1 parent e42c0d2 commit 036ef9c

File tree

6 files changed

+13
-18
lines changed

6 files changed

+13
-18
lines changed

docs/.eslintrc.json

+2
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,13 @@
2222
// Configuration for fenced code blocks goes with the override for
2323
// the code block's virtual filename, for example:
2424
"parserOptions": {
25+
"sourceType": "module",
2526
"ecmaFeatures": {
2627
"impliedStrict": true
2728
}
2829
},
2930
"rules": {
31+
"import/no-unresolved": "off",
3032
"no-array-for-each": "off",
3133
"no-undef": "off",
3234
"no-unused-vars": "off",

docs/content/components/sidebar.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ var sidebar = new coreui.Sidebar(mySidebar)
9292
{{< /highlight >}}
9393

9494

95-
{{< bs-table "table text-left" >}}
95+
{{< bs-table >}}
9696
| Method | Description |
9797
| --- | --- |
9898
| `show` | Shows the sidebar. |
@@ -111,7 +111,7 @@ sidebar.close()
111111

112112
Bootstrap's alert plugin exposes a few events for hooking into alert functionality.
113113

114-
{{< bs-table "table text-left" >}}
114+
{{< bs-table >}}
115115
| Event | Description |
116116
| --- | --- |
117117
| `hidden.coreui.sidebar` | This event is fired immediately when the `hide` instance method has been called. |

docs/content/getting-started/parcel.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ Import [CoreUI's JavaScript]({{< docsref "/getting-started/javascript" >}}) in y
3838

3939
```js
4040
// Import all plugins
41-
import * as coreui from '@coreui/coreui';
41+
import * as coreui from '@coreui/coreui'
4242

4343
// Or import only needed plugins
44-
import { Tooltip as Tooltip, Toast as Toast, Popover as Popover } from '@coreui/coreui';
44+
import { Tooltip, Toast, Popover } from '@coreui/coreui'
4545

4646
// Or import just one
47-
import Alert as Alert from '../node_modules/@coreui/coreui/js/dist/alert';
47+
import Alert from '../node_modules/@coreui/coreui/js/dist/alert'
4848
```
4949

5050
## Importing CSS

docs/content/getting-started/webpack.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ toc: true
1515
Import [CoreUI's JavaScript]({{< docsref "/getting-started/javascript" >}}) by adding this line to your app's entry point (usually `index.js` or `app.js`):
1616

1717
```js
18-
import '@coreui/coreui';
18+
import '@coreui/coreui'
1919

2020
// or get all of the named exports for further usage
21-
import * as coreui from '@coreui/coreui';
21+
import * as coreui from '@coreui/coreui'
2222
```
2323

2424
Alternatively, if you only need just a few of our plugins, you may **import plugins individually** as needed:
2525

2626
```js
27-
import Alert from '@coreui/coreui/js/dist/alert';
27+
import Alert from '@coreui/coreui/js/dist/alert'
2828

2929
// or, specify which plugins you need:
30-
import { Tooltip, Toast, Popover } from '@coreui/coreui';
30+
import { Tooltip, Toast, Popover } from '@coreui/coreui'
3131
```
3232

3333
CoreUI for Bootstrap depends on [Popper](https://popper.js.org/), which is specified in the `peerDependencies` property.
@@ -48,6 +48,7 @@ First, create your own `_custom.scss` and use it to override the [built-in custo
4848

4949
For CoreUI for Bootstrap to compile, make sure you install and use the required loaders: [sass-loader](https://github.com/webpack-contrib/sass-loader), [postcss-loader](https://github.com/webpack-contrib/postcss-loader) with [Autoprefixer](https://github.com/postcss/autoprefixer#webpack). With minimal setup, your webpack config should include this rule or similar:
5050

51+
<!-- eslint-skip -->
5152
```js
5253
// ...
5354
{
@@ -86,7 +87,7 @@ For CoreUI for Bootstrap to compile, make sure you install and use the required
8687
Alternatively, you may use CoreUI's ready-to-use CSS by simply adding this line to your project's entry point:
8788

8889
```js
89-
import '@coreui/coreui/dist/css/coreui.min.css';
90+
import '@coreui/coreui/dist/css/coreui.min.css'
9091
```
9192

9293
In this case you may use your existing rule for `css` without any special modifications to webpack config, except you don't need `sass-loader` just [style-loader](https://github.com/webpack-contrib/style-loader) and [css-loader](https://github.com/webpack-contrib/css-loader).

docs/layouts/_default/baseof.html

-5
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@
77
{{/* {{ partial "skippy" . }} */}}
88
{{ partial "sidebar" . }}
99
<div class="wrapper flex-grow-1">
10-
<div class="alert alert-light d-flex justify-content-center rounded-0 border-bottom">
11-
<span class="me-3">If you like this project and want to help us, please give us a star ⭐️ on Github. ➡️</span>
12-
<a class="github-button" href="https://github.com/coreui/coreui" data-size="large" aria-label="Star coreui/coreui on GitHub">Star</a>
13-
<span class="ms-3">🙏</span>
14-
</div>
1510
{{ partial "header" . }}
1611
{{ block "main" . }}
1712
{{ end }}

docs/layouts/partials/scripts.html

-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,3 @@
1414
{{- end }}
1515

1616
<script src="{{ $docsJs.Permalink | relURL }}"></script>
17-
18-
<!-- Place this tag in your head or just before your close body tag. -->
19-
<script async defer src="https://buttons.github.io/buttons.js"></script>

0 commit comments

Comments
 (0)