Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BSv5] Drop bg-gradient-variant() mixin #1455

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,24 @@ For a list of issues targeted for the next release, see the [23Q1][] milestone.

**Breaking changes**:

- **[Upgraded Bootstrap (#470)][470]** to v5. For a list of Bootstrap breaking
- **[Upgraded Bootstrap ([#470][])** to v5. For a list of Bootstrap breaking
changes, see the [Bootstrap migration guide][bsv5mig]. Other, Docsy-specific
changes are listed below:
- Clean up of unused, or rarely used, variables and functions:
- Dropped `$primary-light`.
- Dropped `color-diff()`.
- BSv4 RTL support, being incompatible with BSv5, has been removed. For
progress in RTL support, see [#1442][1442].

[1442]: https://github.com/google/docsy/issues/1442
progress in RTL support, see [#1442][].
- Dropped the `bg-gradient-variant()` mixin. [#1369][].

**Other changes**:

- Non-breaking changes that result from the Bootstrap v5 upgrade:
- Draw.io diagram edit button: replace custom colors by BS's outline primary.

[470]: https://github.com/google/docsy/issues/470
[#470]: https://github.com/google/docsy/issues/470
[#1369]: https://github.com/google/docsy/issues/1369
[#1442]: https://github.com/google/docsy/issues/1442
[bsv5mig]: https://getbootstrap.com/docs/5.2/migration/

## [0.6.0][]
Expand Down
17 changes: 2 additions & 15 deletions assets/scss/_boxes.scss
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// Boxes on the home page and similar.
.td-box {
}
// Boxes on the home page and similar: .td-box

// box-variant creates the main style for a colored section used on the site.
// box-variant creates the main style for a colored section
@mixin box-variant($parent, $color-name, $color-value) {
$text-color: color-contrast($color-value);
$link-color: mix($blue, $text-color, lightness($color-value));
Expand Down Expand Up @@ -38,22 +36,11 @@
$link-hover-color,
false
);

@if $enable-gradients {
@include bg-gradient-variant(
"#{$parent}--1#{$color-name}#{$parent}--gradient",
$color-value,
true
);
}
}

// Common min-height modifiers used for boxes.
@mixin td-box-height-modifiers($parent) {
#{$parent} {
&--height-auto {
}

&--height-min {
min-height: 300px;
}
Expand Down
7 changes: 0 additions & 7 deletions assets/scss/support/_mixins.scss
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
// Some simple mixins.

@mixin bg-gradient-variant($parent, $color, $ignore-warning: false) {
#{$parent} {
background: $color
linear-gradient(180deg, mix($body-bg, $color, 15%), $color) repeat-x !important;
}
}

@mixin link-variant($parent, $color, $hover-color, $underline: false) {
#{$parent} {
color: $color;
Expand Down
2 changes: 1 addition & 1 deletion layouts/community/list.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{ define "main" -}}

<a class="td-offset-anchor"></a>
<section class="row td-box td-box--primary position-relative td-box--gradient td-box--height-auto">
<section class="row td-box td-box--primary position-relative td-box--height-auto">
<div class="container text-center td-arrow-down">
<span class="h4 mb-0">
<h1>{{ T "community_join" . }}</h1>
Expand Down
2 changes: 1 addition & 1 deletion layouts/partials/community_links.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{{ $links := .Site.Params.links -}}

<section class="row td-box td-box--white td-box--gradient td-box--height-auto linkbox">
<section class="row td-box td-box--white td-box--height-auto linkbox">
<div class="col-xs-12 col-sm-6 col-md-6 col-lg-6">
<h2>{{ T "community_learn" }}</h2>
<p>{{ T "community_using" . }}</p>
Expand Down
20 changes: 10 additions & 10 deletions layouts/shortcodes/blocks/lead.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
{{ $_hugo_config := `{ "version": 1 }` }}
{{ $col_id := .Get "color" | default .Ordinal }}
{{ $height := .Get "height" | default "auto" }}
{{/* Height can be one of: auto, min, med, max, full. */}}
{{ $_hugo_config := `{ "version": 1 }` -}}
{{ $col_id := .Get "color" | default .Ordinal -}}
{{ $height := .Get "height" | default "auto" -}}
{{/* Height can be one of: auto, min, med, max, full. */ -}}
<a id="td-block-{{ .Ordinal }}" class="td-offset-anchor"></a>
<section class="row td-box td-box--{{ $col_id }} position-relative td-box--gradient td-box--height-{{ $height }}">
<section class="row td-box td-box--{{ $col_id }} position-relative td-box--height-{{ $height }}">
<div class="container text-center td-arrow-down">
<div class="h4 mb-0">
{{ if eq .Page.File.Ext "md" }}
{{ .Inner | markdownify }}
{{ else }}
{{ .Inner | htmlUnescape | safeHTML }}
{{ end }}
{{ if eq .Page.File.Ext "md" -}}
{{ .Inner | markdownify -}}
{{ else -}}
{{ .Inner | htmlUnescape | safeHTML -}}
{{ end -}}
</div>
</div>
</section>
20 changes: 10 additions & 10 deletions layouts/shortcodes/blocks/section.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
{{ $_hugo_config := `{ "version": 1 }` }}
{{ $col_id := .Get "color" | default .Ordinal }}
{{ $height := .Get "height" | default "auto" }}
{{ $type := .Get "type" | default "" }}
{{ $_hugo_config := `{ "version": 1 }` -}}
{{ $col_id := .Get "color" | default .Ordinal -}}
{{ $height := .Get "height" | default "auto" -}}
{{ $type := .Get "type" | default "" -}}
<a id="td-block-{{ .Ordinal }}" class="td-offset-anchor"></a>
<section class="row td-box td-box--{{ $col_id }} td-box--gradient td-box--height-{{ $height }}">
<section class="row td-box td-box--{{ $col_id }} td-box--height-{{ $height }}">
<div class="col">
<div class="row {{ $type }}">
{{ if eq .Page.File.Ext "md" }}
{{ .Inner | markdownify }}
{{ else }}
{{ .Inner | htmlUnescape | safeHTML }}
{{ end }}
{{ if eq .Page.File.Ext "md" -}}
{{ .Inner | markdownify -}}
{{ else -}}
{{ .Inner | htmlUnescape | safeHTML -}}
{{ end -}}
</div>
</div>
</section>
9 changes: 3 additions & 6 deletions userguide/content/en/docs/adding-content/lookandfeel.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,9 @@ $primary: #390040;
$secondary: #A23B72;
```

The theme has features such as rounded corners and gradient backgrounds enabled by default. These can also be toggled in your project variables file:

```scss
$enable-gradients: true;
$enable-shadows: true;
```
The theme has features such as gradient backgrounds (`$enable-gradients`) and
shadows (`$enable-shadows`) enabled by default. These can also be toggled in
your project variables file by setting the variables to `false`.

## Fonts

Expand Down