8000 docs: update documentation · coreui/coreui-pro@654e976 · GitHub
[go: up one dir, main page]
Skip to content
8000

Commit 654e976

Browse files
mrholekmrholek
committed
docs: update documentation
1 parent b74ff6a commit 654e976

32 files changed

+172
-0
lines changed

‎README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,20 @@
1919
<a href="https://coreui.io/blog/">Blog</a>
2020
</p>
2121

22+
## CoreUI vs Bootstrap
23+
24+
CoreUI is fully compatible with Bootstrap, but it’s more than just a theme or UI extension — it’s a professionally developed and maintained system that addresses many of the limitations developers face with Bootstrap alone.
25+
26+
**Key differences between CoreUI and Bootstrap:**
27+
28+
* ✅ **Framework-native versions** – CoreUI offers official libraries for [React.js](https://coreui.io/react/), [Vue.js](https://coreui.io/vue/), and [Angular](https://coreui.io/angular/), while Bootstrap depends on third-party community plugins for framework integration.
29+
* 👨‍💻 **Full-time maintained project** – CoreUI is not a community-only initiative. It’s developed by a dedicated, full-time team focused on long-term evolution and support.
30+
* 📦 **More built-in components** – CoreUI includes many components not present in Bootstrap by default, such as range sliders, multi-selects, and step-based form wizards.
31+
* 🛠️ **Sass Modules support today** – CoreUI already supports Sass Modules out of the box, a feature that Bootstrap plans to introduce in version 6.
32+
* 🌍 **Modern RTL/LTR support** – CoreUI uses CSS logical properties to provide seamless RTL and LTR layout support for multilingual and internationalized apps.
33+
* 🔒 **Long-Term Support (LTS)** – While Bootstrap 3 & 4 LTS is now a paid service via [HeroDevs](https://www.herodevs.com/support/nes-bootstrap?utm_source=Bootstrap_site&utm_medium=Banner&utm_campaign=v3and4_eol), CoreUI continues to offer long-term support without additional cost.
34+
35+
Whether you're starting a new project or migrating from Bootstrap, CoreUI gives you a powerful upgrade path with more features, framework bindings, and peace of mind for long-term maintainability.
2236

2337
## Table of contents
2438

‎docs/content/components/accordion.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ aliases:
99
toc: true
1010
bootstrap: true
1111
other_frameworks: accordion
12+
# schema:
13+
# description: Documentation and usage examples for Bootstrap Accordion component built with CoreUI.
14+
# headline: Bootstrap Accordion Component – Usage & Examples
15+
# keywords: Accordion, Bootstrap, Component, CoreUI
1216
---
1317

1418
## How it works
@@ -163,4 +167,9 @@ Accordions use local CSS variables on .accordion for enhanced real-time customiz
163167
{{< scss-docs name="accordion-css-vars" file="scss/_accordion.scss" >}}
164168

165169
### SASS variables
170+
166171
{{< scss-docs name="accordion-variables" file="scss/_variables.scss" >}}
172+
173+
{{< markdown >}}
174+
{{< coreui-vs-bootstrap component="Accordion" >}}
175+
{{< /markdown >}}

‎docs/content/components/alerts.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,3 +258,7 @@ Used alongside `$alert-variants` to create contextual modifier classes for our a
258258
Loop that creates the modifier classes with the `alert-variant()` mixin.
259259

260260
{{< scss-docs name="alert-modifiers" file="scss/_alert.scss" >}}
261+
262+
{{< markdown >}}
263+
{{< coreui-vs-bootstrap component="Alert" >}}
264+
{{< /markdown >}}

‎docs/content/components/badge.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,7 @@ Badges use local CSS variables on `.badge` for enhanced real-time customization.
101101
### SASS variables
102102

103103
{{< scss-docs name="badge-variables" file="scss/_variables.scss" >}}
104+
105+
{{< markdown >}}
106+
{{< coreui-vs-bootstrap component="Badge" >}}
107+
{{< /markdown >}}

‎docs/content/components/breadcrumb.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,3 +112,6 @@ Breadcrumbs use local CSS variables on `.breadcrumb` for enhanced real-time cust
112112

113113
{{< scss-docs name="breadcrumb-variables" file="scss/_variables.scss" >}}
114114

115+
{{< markdown >}}
116+
{{< coreui-vs-bootstrap component="Breadcrumb" >}}
117+
{{< /markdown >}}

‎docs/content/components/button-group.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,3 +268,7 @@ Create a set of buttons that appear vertically stacked rather than horizontally.
268268
<label class="btn btn-outline-danger" for="vbtn-radio3">Radio 3</label>
269269
</div>
270270
{{< /example >}}
271+
272+
{{< markdown >}}
273+
{{< coreui-vs-bootstrap component="Button Group" >}}
274+
{{< /markdown >}}

‎docs/content/components/buttons.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,3 +356,7 @@ There are three mixins for buttons: button and button outline variant mixins, pl
356356
Button variants (for regular and outline buttons) use their respective mixins with our `$theme-colors` map to generate the modifier classes in `scss/_buttons.scss`.
357357

358358
{{< scss-docs name="btn-variant-loops" file="scss/_buttons.scss" >}}
359+
360+
{{< markdown >}}
361+
{{< coreui-vs-bootstrap component="Button" >}}
362+
{{< /markdown >}}

‎docs/content/components/card.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -756,3 +756,6 @@ Cards use local CSS variables on `.card` for enhanced real-time customization. V
756756

757757
{{< scss-docs name="card-variables" file="scss/_variables.scss" >}}
758758

759+
{{< markdown >}}
760+
{{< coreui-vs-bootstrap component="Card" >}}
761+
{{< /markdown >}}

‎docs/content/components/carousel.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -391,3 +391,7 @@ Variables for all carousels:
391391
Variables for the [dark carousel](#dark-variant):
392392

393393
{{< scss-docs name="carousel-dark-variables" file="scss/_variables.scss" >}}
394+
395+
{{< markdown >}}
396+
{{< coreui-vs-bootstrap component="Carousel" >}}
397+
{{< /markdown >}}

‎docs/content/components/close-button.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,7 @@ Add `data-coreui-theme="dark"` to the `.btn-close`, or to its parent element, to
4646
### SASS variables
4747

4848
{{< scss-docs name="close-variables" file="scss/_variables.scss" >}}
49+
50+
{{< markdown >}}
51+
{{< coreui-vs-bootstrap component="Close Button" >}}
52+
{{< /markdown >}}

0 commit comments

Comments
 (0)
0