Skip to content

Commit c27ca7f

Browse files
mrholekmrholek
committed
docs: update documentation
1 parent bd783f4 commit c27ca7f

39 files changed

+677
-751
lines changed

‎docs/.vuepress/clientAppEnhance.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,15 @@ import '@coreui/coreui/scss/coreui.scss'
66

77
import {
88
cibCoreuiC,
9+
cibDiscourse,
10+
cibGithub,
11+
cibTwitter,
912
cilArrowBottom,
1013
cilArrowRight,
1114
cilArrowTop,
1215
cilBasket,
16+
cilCloudDownload,
17+
cilMenu,
1318
cilOptions,
1419
cilPeople,
1520
cilPuzzle,
@@ -20,10 +25,15 @@ import {
2025

2126
export const icons = {
2227
cibCoreuiC,
28+
cibDiscourse,
29+
cibGithub,
30+
cibTwitter,
2331
cilArrowBottom,
2432
cilArrowRight,
2533
cilArrowTop,
2634
cilBasket,
35+
cilCloudDownload,
36+
cilMenu,
2737
cilOptions,
2838
cilPeople,
2939
cilPuzzle,

‎docs/.vuepress/config.ts

Lines changed: 55 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -55,224 +55,216 @@ export default defineUserConfig<DefaultThemeOptions>({
5555
sidebar: [
5656
{
5757
text: 'Getting started',
58-
icon: `<svg version="1.1" xmlns="http://www.w3.org/2000/svg" class="nav-icon text-primary" width="64" height="64" viewBox="0 0 64 64">
59-
<title>energy</title>
60-
<path d="M40 26v-24h-4.012l-27.941 38h16.953v22h3.975l28.125-36zM15.953 36l20.047-27.264v21.264h12.9l-19.9 25.471v-19.471z"></path>
61-
</svg>`,
58+
icon: '<rect width="32" height="32" x="144" y="464" fill="var(--ci-primary-color, currentColor)" class="ci-primary"></rect><rect width="32" height="32" x="240" y="464" fill="var(--ci-primary-color, currentColor)" class="ci-primary"></rect><rect width="32" height="32" x="336" y="464" fill="var(--ci-primary-color, currentColor)" class="ci-primary"></rect><path fill="var(--ci-primary-color, currentColor)" d="M312,76.82v34.265a142.419,142.419,0,0,1,86.207,130.708C398.207,320.206,334.413,384,256,384S113.793,320.206,113.793,241.793A142.419,142.419,0,0,1,200,111.085V76.82c-68.671,23.373-118.207,88.5-118.207,164.973C81.793,337.851,159.942,416,256,416s174.207-78.149,174.207-174.207C430.207,165.316,380.671,100.193,312,76.82Z" class="ci-primary"></path><rect width="32" height="229.793" x="240" y="16" fill="var(--ci-primary-color, currentColor)" class="ci-primary"></rect>',
59+
link: `/${pkg.config.version_short}/getting-started/`,
6260
children: [
6361
{
6462
text: 'Introduction',
65-
link: `/${pkg.config.version_short}/getting-started/introduction.md`,
63+
link: `/${pkg.config.version_short}/getting-started/introduction.html`,
6664
}
6765
]
6866
},
6967
{
7068
text: 'Layout',
71-
icon: `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" class="nav-icon text-primary">
72-
<path fill="var(--ci-primary-color, currentColor)" d="M16,64V448H496V64ZM464,240H192V96H464ZM192,272H312V416H192ZM48,96H160V416H48ZM344,416V272H464V416Z" class="ci-primary"></path>
73-
</svg>`,
69+
icon: `<path fill="var(--ci-primary-color, currentColor)" d="M16,64V448H496V64ZM464,240H192V96H464ZM192,272H312V416H192ZM48,96H160V416H48ZM344,416V272H464V416Z"></path>`,
70+
link: `/${pkg.config.version_short}/layout/`,
7471
children: [
7572
{
7673
text: 'Breakpoints',
77-
link: `/${pkg.config.version_short}/layout/breakpoints.md`,
74+
link: `/${pkg.config.version_short}/layout/breakpoints.html`,
7875
},
7976
{
8077
text: 'Columns',
81-
link: `/${pkg.config.version_short}/layout/columns.md`,
78+
link: `/${pkg.config.version_short}/layout/columns.html`,
8279
},
8380
{
8481
text: 'Containers',
85-
link: `/${pkg.config.version_short}/layout/containers.md`,
82+
link: `/${pkg.config.version_short}/layout/containers.html`,
8683
},
8784
{
8885
text: 'Grid',
89-
link: `/${pkg.config.version_short}/layout/grid.md`,
86+
link: `/${pkg.config.version_short}/layout/grid.html`,
9087
},
9188
{
9289
text: 'Gutters',
93-
link: `/${pkg.config.version_short}/layout/gutters.md`,
90+
link: `/${pkg.config.version_short}/layout/gutters.html`,
9491
},
9592
],
9693
},
9794
{
9895
text: 'Forms',
99-
icon: `<svg xmlns="http://www.w3.org/2000/svg" class="nav-icon text-primary" viewBox="0 0 512 512">
100-
<path fill="var(--ci-primary-color, currentColor)" d="M23.686,456.521a24.841,24.841,0,0,0,6,25.708l.087.087a24.841,24.841,0,0,0,17.612,7.342,25.179,25.179,0,0,0,8.1-1.344h0a646.28,646.28,0,0,0,248.04-154.207L469.981,167.646A88.832,88.832,0,1,0,344.354,42.019l-9.534,9.534L314.029,30.762a50.4,50.4,0,0,0-71.274,0L108.687,164.83l22.626,22.627L265.382,53.389a18.4,18.4,0,0,1,26.019,0L312.193,74.18l-134.3,134.3A646.28,646.28,0,0,0,23.686,456.521Zm343.3-391.875a56.832,56.832,0,1,1,80.373,80.373l-89.493,89.493-80.372-80.373ZM254.862,176.766l80.372,80.372L280.892,311.48A614.383,614.383,0,0,1,58.779,453.221,614.383,614.383,0,0,1,200.52,231.108Z" class="ci-primary"></path>
101-
</svg>`,
96+
icon: `<rect width="288" height="32" x="112" y="152" fill="var(--ci-primary-color, currentColor)" class="ci-primary"></rect><rect width="288" height="32" x="112" y="240" fill="var(--ci-primary-color, currentColor)" class="ci-primary"></rect><rect width="152" height="32" x="112" y="328" fill="var(--ci-primary-color, currentColor)" class="ci-primary"></rect><path fill="var(--ci-primary-color, currentColor)" d="M480,48H32V464H480ZM448,432H64V80H448Z" class="ci-primary"></path>`,
97+
link: `/${pkg.config.version_short}/forms/`,
10298
children: [
10399
{
104100
text: 'Overview',
105-
link: `/${pkg.config.version_short}/forms/overview.md`,
101+
link: `/${pkg.config.version_short}/forms/overview.html`,
106102
},
107103
{
108104
text: 'Form control',
109-
link: `/${pkg.config.version_short}/forms/form-control.md`,
105+
link: `/${pkg.config.version_short}/forms/form-control.html`,
110106
},
111107
{
112108
text: 'Select',
113-
link: `/${pkg.config.version_short}/forms/select.md`,
109+
link: `/${pkg.config.version_short}/forms/select.html`,
114110
},
115111
{
116112
text: 'Checks & radios',
117-
link: `/${pkg.config.version_short}/forms/checks-radios.md`,
113+
link: `/${pkg.config.version_short}/forms/checks-radios.html`,
118114
},
119115
{
120116
text: 'Range',
121-
link: `/${pkg.config.version_short}/forms/range.md`,
117+
link: `/${pkg.config.version_short}/forms/range.html`,
122118
},
123119
{
124120
text: 'Floating labels',
125-
link: `/${pkg.config.version_short}/forms/floating-labels.md`,
121+
link: `/${pkg.config.version_short}/forms/floating-labels.html`,
126122
},
127123
{
128124
text: 'Input group',
129-
link: `/${pkg.config.version_short}/forms/input-group.md`,
125+
link: `/${pkg.config.version_short}/forms/input-group.html`,
130126
},
131127
{
132128
text: 'Layout',
133-
link: `/${pkg.config.version_short}/forms/layout.md`,
129+
link: `/${pkg.config.version_short}/forms/layout.html`,
134130
},
135131
{
136132
text: 'Validation',
137-
link: `/${pkg.config.version_short}/forms/validation.md`,
133+
link: `/${pkg.config.version_short}/forms/validation.html`,
138134
},
139135
],
140136
},
141137
{
142138
text: 'Components',
143-
icon: `<svg version="1.1" xmlns="http://www.w3.org/2000/svg" class="nav-icon text-primary" width="64" height="64" viewBox="0 0 64 64">
144-
<title>energy</title>
145-
<path d="M40 26v-24h-4.012l-27.941 38h16.953v22h3.975l28.125-36zM15.953 36l20.047-27.264v21.264h12.9l-19.9 25.471v-19.471z"></path>
146-
</svg>`,
139+
icon: '<path fill="var(--ci-primary-color, currentColor)" d="M410.989,16H101.011L16,237.029V496H496V237.029Zm-288,32H240V240H49.143ZM184,272H328v40H184ZM464,464H48V272H152v72H360V272H464ZM272,240V48H389.012l73.845,192Z" class="ci-primary"></path>',
140+
link: `/${pkg.config.version_short}/components/`,
147141
children: [
148142
{
149143
text: 'Accordion',
150-
link: `/${pkg.config.version_short}/components/accordion.md`,
144+
link: `/${pkg.config.version_short}/components/accordion.html`,
151145
},
152146
{
153147
text: 'Alert',
154-
link: `/${pkg.config.version_short}/components/alert.md`,
148+
link: `/${pkg.config.version_short}/components/alert.html`,
155149
},
156150
{
157151
text: 'Avatar',
158-
link: `/${pkg.config.version_short}/components/avatar.md`,
152+
link: `/${pkg.config.version_short}/components/avatar.html`,
159153
},
160154
{
161155
text: 'Badge',
162-
link: `/${pkg.config.version_short}/components/badge.md`,
156+
link: `/${pkg.config.version_short}/components/badge.html`,
163157
},
164158
{
165159
text: 'Breadcrumb',
166-
link: `/${pkg.config.version_short}/components/breadcrumb.md`,
160+
link: `/${pkg.config.version_short}/components/breadcrumb.html`,
167161
},
168162
{
169163
text: 'Buttons',
170-
link: `/${pkg.config.version_short}/components/button.md`,
164+
link: `/${pkg.config.version_short}/components/button.html`,
171165
},
172166
{
173167
text: 'Button Group',
174-
link: `/${pkg.config.version_short}/components/button-group.md`,
168+
link: `/${pkg.config.version_short}/components/button-group.html`,
175169
},
176170
{
177171
text: 'Callout',
178-
link: `/${pkg.config.version_short}/components/callout.md`,
172+
link: `/${pkg.config.version_short}/components/callout.html`,
179173
},
180174
{
181175
text: 'Card',
182-
link: `/${pkg.config.version_short}/components/card.md`,
176+
link: `/${pkg.config.version_short}/components/card.html`,
183177
},
184178
{
185179
text: 'Carousel',
186-
link: `/${pkg.config.version_short}/components/carousel.md`,
180+
link: `/${pkg.config.version_short}/components/carousel.html`,
187181
},
188182
{
189183
text: 'Close Button',
190-
link: `/${pkg.config.version_short}/components/close-button.md`,
184+
link: `/${pkg.config.version_short}/components/close-button.html`,
191185
},
192186
{
193187
text: 'Collapse',
194-
link: `/${pkg.config.version_short}/components/collapse.md`,
188+
link: `/${pkg.config.version_short}/components/collapse.html`,
195189
},
196190
{
197191
text: 'Dropdown',
198-
link: `/${pkg.config.version_short}/components/dropdown.md`,
192+
link: `/${pkg.config.version_short}/components/dropdown.html`,
199193
},
200194
{
201195
text: 'Footer',
202-
link: `/${pkg.config.version_short}/components/footer.md`,
196+
link: `/${pkg.config.version_short}/components/footer.html`,
203197
},
204198
{
205199
text: 'Header',
206-
link: `/${pkg.config.version_short}/components/header.md`,
200+
link: `/${pkg.config.version_short}/components/header.html`,
207201
},
208202
{
209203
text: 'Image',
210-
link: `/${pkg.config.version_short}/components/image.md`,
204+
link: `/${pkg.config.version_short}/components/image.html`,
211205
},
212206
{
213207
text: 'List Group',
214-
link: `/${pkg.config.version_short}/components/list-group.md`,
208+
link: `/${pkg.config.version_short}/components/list-group.html`,
215209
},
216210
{
217211
text: 'Modal',
218-
link: `/${pkg.config.version_short}/components/modal.md`,
212+
link: `/${pkg.config.version_short}/components/modal.html`,
219213
},
220214
{
221215
text: 'Nav',
222-
link: `/${pkg.config.version_short}/components/nav.md`,
216+
link: `/${pkg.config.version_short}/components/nav.html`,
223217
},
224218
{
225219
text: 'Navbar',
226-
link: `/${pkg.config.version_short}/components/navbar.md`,
220+
link: `/${pkg.config.version_short}/components/navbar.html`,
227221
},
228222
{
229223
text: 'Offcanvas',
230-
link: `/${pkg.config.version_short}/components/offcanvas.md`,
224+
link: `/${pkg.config.version_short}/components/offcanvas.html`,
231225
},
232226
{
233227
text: 'Pagination',
234-
link: `/${pkg.config.version_short}/components/pagination.md`,
228+
link: `/${pkg.config.version_short}/components/pagination.html`,
235229
},
236230
{
237231
text: 'Progress',
238-
link: `/${pkg.config.version_short}/components/progress.md`,
232+
link: `/${pkg.config.version_short}/components/progress.html`,
239233
},
240234
{
241235
text: 'Sidebar',
242-
link: `/${pkg.config.version_short}/components/sidebar.md`,
236+
link: `/${pkg.config.version_short}/components/sidebar.html`,
243237
},
244238
{
245239
text: 'Spinner',
246-
link: `/${pkg.config.version_short}/components/spinner.md`,
240+
link: `/${pkg.config.version_short}/components/spinner.html`,
247241
},
248242
{
249243
text: 'Table',
250-
link: `/${pkg.config.version_short}/components/table.md`,
244+
link: `/${pkg.config.version_short}/components/table.html`,
251245
},
252246
{
253247
text: 'Toast',
254-
link: `/${pkg.config.version_short}/components/toast.md`,
248+
link: `/${pkg.config.version_short}/components/toast.html`,
255249
},
256250
{
257251
text: 'Widgets',
258-
link: `/${pkg.config.version_short}/components/widgets.md`,
252+
link: `/${pkg.config.version_short}/components/widgets.html`,
259253
},
260254
],
261255
},
262256
{
263257
text: 'Directives',
264-
icon: `<svg version="1.1" xmlns="http://www.w3.org/2000/svg" class="nav-icon text-primary" width="64" height="64" viewBox="0 0 64 64">
265-
<title>energy</title>
266-
<path d="M40 26v-24h-4.012l-27.941 38h16.953v22h3.975l28.125-36zM15.953 36l20.047-27.264v21.264h12.9l-19.9 25.471v-19.471z"></path>
267-
</svg>`,
258+
icon: '<path fill="var(--ci-primary-color, currentColor)" d="M410.989,16H101.011L16,237.029V496H496V237.029Zm-288,32H240V240H49.143ZM184,272H328v40H184ZM464,464H48V272H152v72H360V272H464ZM272,240V48H389.012l73.845,192Z" class="ci-primary"></path>',
259+
link: `/${pkg.config.version_short}/directives/`,
268260
children: [
269261
{
270262
text: 'Popover',
271-
link: `/${pkg.config.version_short}/directives/popover.md`,
263+
link: `/${pkg.config.version_short}/directives/popover.html`,
272264
},
273265
{
274266
text: 'Tooltip',
275-
link: `/${pkg.config.version_short}/directives/tooltip.md`,
267+
link: `/${pkg.config.version_short}/directives/tooltip.html`,
276268
},
277269
]
278270
}

‎docs/.vuepress/theme-coreui/src/client/components/Footer.vue

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<template>
2+
<CFooter class="docs-footer p-3 p-md-5 mt-5 text-center text-sm-start">
3+
<CContainer>
4+
<ul class="docs-footer-links ps-0 mb-3">
5+
<li class="d-inline-block">
6+
<a href="https://github.com/coreui">GitHub</a>
7+
</li>
8+
<li class="d-inline-block ms-3">
9+
<a href="https://twitter.com/core_ui">Twitter</a>
10+
</li>
11+
<li class="d-inline-block ms-3">
12+
<a href="https://community.coreui.io/">Community</a>
13+
</li>
14+
<li class="d-inline-block ms-3 ps-3 border-start border-2">
15+
<a href="https://coreui.io/">CoreUI (Vanilla)</a>
16+
</li>
17+
<li class="d-inline-block ms-3">
18+
<a href="https://coreui.io/angular/">CoreUI for Angular</a>
19+
</li>
20+
<li class="d-inline-block ms-3">
21+
<a href="https://coreui.io/react/">CoreUI for React.js</a>
22+
</li>
23+
</ul>
24+
<p class="mb-0">CoreUI for Vue is Open Source UI Components Library for Vue.js.</p>
25+
<p class="mb-0">
26+
Currently v{{ version }}. Code licensed
27+
<a
28+
href="https://github.com/coreui/coreui/blob/main/LICENSE"
29+
target="_blank"
30+
rel="license noopener"
31+
>
32+
MIT
33+
</a>
34+
, docs
35+
<a
36+
href="https://creativecommons.org/licenses/by/3.0/"
37+
target="_blank"
38+
rel="license noopener"
39+
>
40+
CC BY 3.0
41+
</a>
42+
.
43+
</p>
44+
</CContainer>
45+
</CFooter>
46+
</template>
47+
48+
<script lang="ts">
49+
import { defineComponent } from 'vue'
50+
import pkg from './../../../../../../package.json'
51+
export default defineComponent({
52+
name: 'Footer',
53+
setup () {
54+
const version = pkg.version
55+
return {
56+
version
57+
}
58+
}
59+
})
60+
</script>

0 commit comments

Comments
 (0)