Skip to content

Commit e2e5c61

Browse files
committed
docs: update theme
1 parent 808735e commit e2e5c61

File tree

19 files changed

+21
-24
lines changed

19 files changed

+21
-24
lines changed

config.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@ languageCode: "en"
22
title: "CoreUI"
33
baseURL: "https://coreui.io/docs/"
44
canonifyURLs: true
5-
enableInlineShortcodes: true
5+
6+
security:
7+
enableInlineShortcodes: true
8+
funcs:
9+
getenv:
10+
- ^HUGO_
11+
- NETLIFY
612

713
markup:
814
goldmark:

docs/assets/scss/_layout.scss

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
.docs-layout {
99
@include media-breakpoint-up(md) {
1010
display: grid;
11-
gap: $grid-gutter-width;
1211
grid-template-areas: "sidebar main";
1312
grid-template-columns: 1fr 3fr;
13+
gap: $grid-gutter-width;
1414
}
1515

1616
@include media-breakpoint-up(lg) {
@@ -27,20 +27,20 @@
2727

2828
@include media-breakpoint-up(md) {
2929
display: grid;
30-
gap: inherit;
3130
grid-template-areas:
3231
"intro"
3332
"toc"
3433
"content";
3534
grid-template-rows: auto auto 1fr;
35+
gap: inherit;
3636
}
3737

3838
@include media-breakpoint-up(lg) {
3939
grid-template-areas:
4040
"intro toc"
4141
"content toc";
42-
grid-template-columns: 4fr 1fr;
4342
grid-template-rows: auto 1fr;
43+
grid-template-columns: 4fr 1fr;
4444
}
4545
}
4646

docs/assets/scss/_placeholder-img.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
.docs-placeholder-img {
88
@include font-size(1.125rem);
9-
text-anchor: middle;
109
user-select: none;
10+
text-anchor: middle;
1111
}
1212

1313
.docs-placeholder-img-lg {

docs/assets/scss/docs.scss

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*!
22
* CoreUI Docs (https://coreui.io/docs/)
3-
* Copyright 2021 creativeLabs Łukasz Holeczek
3+
* Copyright 2022 creativeLabs Łukasz Holeczek
44
* Copyright 2011-2020 The Bootstrap Authors
55
* Copyright 2011-2020 Twitter, Inc.
66
* Licensed under the Creative Commons Attribution 3.0 Unported License.
@@ -39,25 +39,20 @@ $enable-cssgrid: true; // stylelint-disable-line scss/dollar-variable-default
3939

4040
// Load docs components
4141
@import "variables";
42-
// @import "navbar";
4342
@import "subnav";
4443
@import "masthead";
45-
@import "ads";
4644
@import "content";
4745
@import "skippy";
4846
@import "sidebar";
4947
@import "layout";
5048
@import "toc";
5149
@import "footer";
5250
@import "component-examples";
53-
// @import "buttons";
5451
@import "callouts";
55-
@import "brand";
5652
@import "colors";
5753
@import "clipboard-js";
5854
@import "placeholder-img";
5955

6056
// Load docs dependencies
6157
@import "syntax";
6258
@import "anchor";
63-
// @import "algolia";

docs/content/components/buttons.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,6 @@ Disabled buttons using the `<a>` element act a little different:
149149
<a href="#" class="btn btn-secondary btn-lg disabled" tabindex="-1" role="button" aria-disabled="true">Link</a>
150150
{{< /example >}}
151151

152-
{{< callout warning >}}
153-
154152
### Link functionality caveat
155153

156154
To cover cases where you have to keep the `href` attribute on a disabled link, the `.disabled` class uses `pointer-events: none` to try to disable the link functionality of `<a>`s. Note that this CSS property is not yet standardized for HTML, but all modern browsers support it. In addition, even in browsers that do support `pointer-events: none`, keyboard navigation remains unaffected, meaning that sighted keyboard users and users of assistive technologies will still be able to activate these links. So to be safe, in addition to `aria-disabled="true"`, also include a `tabindex="-1"` attribute on these links to prevent them from receiving keyboard focus, and use custom JavaScript to disable their functionality altogether.

docs/content/components/sidebar.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ toc: true
1212

1313
Here's what you need to know before getting started with the sidebar:
1414

15-
- Sidebar requires a wrapping `.sidebar-`.
16-
- Sidebar is hidden by default. Force it to be shown by adding `.sidebar-{-sm|-md|-lg|-xl|-xxl}-show` or `.sidebar-show` to the `.sidebar`.
15+
- Sidebar requires a wrapping `.sidebar`.
16+
- Sidebar is hidden by default on mobile devices. Force it to be shown by adding `.show` to the `.sidebar`.
17+
- Sidebar is shown by default on desktop devices. Force it to be hidden by adding `.hide` to the `.sidebar`.
1718
- Ensure accessibility by using a `<nav>` element or, if using a more generic element such as a `<div>`, add a `role="navigation"` to `.sidebar-nav` to explicitly identify it as a landmark region for users of assistive technologies.
1819

1920
Read on for an example and list of supported sub-components.
@@ -79,12 +80,6 @@ Sidebar come with built-in support for a handful of sub-components. Choose from
7980
{{< /sidebar.inline >}}
8081
{{< /example >}}
8182

82-
## Responsive behaviors
83-
84-
Sidebar can utilize `.sidebar-{-sm|-md|-lg|-xl|-xxl}-show` classes to change whether is visible or hidden. You can easily choose when to show or hide sidebar.
85-
86-
For sidebar that is always visible, add the `.sidebar-show` class on the sidebar
87-
8883
## JavaScript behavior
8984

9085
### Methods

docs/layouts/_default/docs.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
<main class="docs-main order-1">
44
<div class="docs-intro ps-lg-4">
55
{{ partial "breadcrumb" . }}
6-
<div class="d-md-flex flex-md-row-reverse align-items-center justify-content-between">
6+
<!-- <div class="d-md-flex flex-md-row-reverse align-items-center justify-content-between">
77
<a class="btn btn-sm btn-outline-secondary mb-2 mb-md-0" href="{{ .Site.Params.repo }}/blob/main/docs/content/{{ .Page.File.Path | replaceRE `\\` "/" }}" title="View and edit this file on GitHub" target="_blank" rel="noopener">View on GitHub</a>
88
<h1 class="docs-title" id="content">{{ .Title | markdownify }}</h1>
9-
</div>
9+
</div> -->
1010
<p class="docs-lead">{{ .Page.Params.Description | markdownify }}</p>
1111
{{ partial "ads" . }}
1212
</div>

docs/layouts/_default/section.html

Whitespace-only changes.

docs/layouts/partials/footer.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
<ul class="docs-footer-links ps-0 mb-3">
44
<li class="d-inline-block"><a href="{{ .Site.Params.github_org }}">GitHub</a></li>
55
<li class="d-inline-block ms-3"><a href="https://twitter.com/{{ .Site.Params.twitter }}">Twitter</a></li>
6+
<li class="d-inline-block ms-3 ps-3 border-start border-2"><a href="https://coreui.io/angular/">CoreUI for Angular</a></li>
7+
<li class="d-inline-block ms-3"><a href="https://coreui.io/react/">CoreUI for React.js</a></li>
8+
<li class="d-inline-block ms-3"><a href="https://coreui.io/vue/">CoreUI for Vue.js</a></li>
69
</ul>
710
<p class="mb-0">CoreUI is designed as the extension of <a href="https://getbootstrap.com">Bootstrap</a>. Special thanks for <a href="https://getbootstrap.com/docs/5.0/about/team/">Bootstrap team</a> and <a href="https://github.com/twbs/bootstrap/graphs/contributors">Bootstrap's contributors</a>.</p>
811
<p class="mb-0">Currently v{{ .Site.Params.current_version }}. Code licensed <a href="{{ .Site.Params.repo }}/blob/main/LICENSE" target="_blank" rel="license noopener">MIT</a>, docs <a href="https://creativecommons.org/licenses/by/3.0/" target="_blank" rel="license noopener">CC BY 3.0</a>.</p>

docs/layouts/partials/sidebar.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
JavaScript / Vanilla JS
99
</button>
1010
<ul class="dropdown-menu w-100" aria-labelledby="dropdownMenuButton1">
11-
<li><a class="dropdown-item disabled" href="#" disabled>Angular <span class="badge bg-warning float-end mt-1">Work in Progress</span></a></li>
11+
<li><a class="dropdown-item" href="https://coreui.io/angular/docs/4.0/getting-started/introduction">Angular</a></li>
1212
<li><a class="dropdown-item" href="https://coreui.io/react/docs/" target="_blank">React.js</a></li>
1313
<li><a class="dropdown-item" href="https://coreui.io/vue/docs/" target="_blank">Vue.js</a></li>
1414
</ul>

0 commit comments

Comments
 (0)