Skip to content

Commit

Permalink
Merge 3b42a2d into b1f8039
Browse files Browse the repository at this point in the history
  • Loading branch information
julien-deramond committed Jul 1, 2024
2 parents b1f8039 + 3b42a2d commit b0787f7
Show file tree
Hide file tree
Showing 251 changed files with 70 additions and 96 deletions.
4 changes: 2 additions & 2 deletions NOTICE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ site/static/docs/**/assets/brand/orange-logo.svg
site/static/docs/**/assets/brand/orange-logo-formatted.svg
site/static/docs/**/assets/brand/orange-social.png
site/static/docs/**/assets/brand/orange-social.svg
site/static/docs/**/assets/img/boosted-guidelines.png
site/static/docs/**/assets/img/boosted-guidelines@2x.png
site/static/docs/**/assets/img/ouds-web-guidelines.png
site/static/docs/**/assets/img/ouds-web-guidelines@2x.png
site/static/docs/**/assets/img/boosted-sprite.svg
site/static/docs/**/assets/img/boosted-warning.svg
site/static/docs/**/assets/img/favicons/android-chrome-192x192.png
Expand Down
36 changes: 18 additions & 18 deletions hugo.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
languageCode: "en"
title: "Boosted"
title: "OUDS Web"
baseURL: "https://boosted.orange.com"

security:
Expand Down Expand Up @@ -34,7 +34,7 @@ publishDir: "_site"
module:
mounts:
- source: dist
target: static/docs/5.3/dist
target: static/docs/0.1/dist
- source: site/assets
target: assets
- source: site/content
Expand All @@ -47,27 +47,27 @@ module:
target: static
- source: node_modules/@docsearch/css
target: assets/scss/@docsearch/css
- source: site/static/docs/5.3/assets/img/favicons/apple-touch-icon.png
- source: site/static/docs/0.1/assets/img/favicons/apple-touch-icon.png
target: static/apple-touch-icon.png
- source: site/static/docs/5.3/assets/img/favicons/favicon.ico
- source: site/static/docs/0.1/assets/img/favicons/favicon.ico
target: static/favicon.ico

# OUDS mod
- source: node_modules/tarteaucitronjs/tarteaucitron.min.js
target: static/docs/5.3/assets/js/tarteaucitron.min.js
target: static/docs/0.1/assets/js/tarteaucitron.min.js
- source: node_modules/tarteaucitronjs/lang
target: static/docs/5.3/assets/js/lang
target: static/docs/0.1/assets/js/lang
- source: site/storybook
target: static/storybook

params:
subtitle: "Orange Boosted with Bootstrap is a Bootstrap based, Orange branded accessible and ergonomic components library…"
subtitle: "OUDS Web is a Bootstrap based, Orange branded accessible and ergonomic components library…"
description: "Powerful, extensible, and feature-packed frontend toolkit. Build and customize with Sass, utilize prebuilt grid system and components, and bring projects to life with powerful JavaScript plugins."
authors: "Orange and Boosted contributors"
authors: "Orange and OUDS Web contributors"

current_version: "5.3.3"
current_ruby_version: "5.3.3"
docs_version: "5.3"
current_version: "0.1.0"
current_ruby_version: "0.1.0"
docs_version: "0.1"
rfs_version: "v10.0.0"
bootstrap_github_org: "https://github.com/twbs"
repo: "https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap"
Expand All @@ -87,19 +87,19 @@ params:
indexName: "boosted-orange"

download:
source: "https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/archive/v5.3.3.zip"
dist: "https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/releases/download/v5.3.3/boosted-5.3.3-dist.zip"
dist_examples: "https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/releases/download/v5.3.3/boosted-5.3.3-examples.zip"
source: "https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/archive/v0.1.0.zip"
dist: "https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/releases/download/v0.1.0-ouds/ouds-web-0.1.0-dist.zip"
dist_examples: "https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/releases/download/v0.1.0-ouds/ouds-web-0.1.0-examples.zip"

cdn:
# See https://www.srihash.org for info on how to generate the hashes
css: "https://cdn.jsdelivr.net/npm/boosted@5.3.3/dist/css/boosted.min.css"
css: "https://cdn.jsdelivr.net/npm/ouds-web@0.1.0/dist/css/ouds-web.min.css"
css_hash: "sha384-laZ3JUZ5Ln2YqhfBvadDpNyBo7w5qmWaRnnXuRwNhJeTEFuSdGbzl4ZGHAEnTozR"
css_rtl: "https://cdn.jsdelivr.net/npm/boosted@5.3.3/dist/css/boosted.rtl.min.css"
css_rtl: "https://cdn.jsdelivr.net/npm/ouds-web@0.1.0/dist/css/ouds-web.rtl.min.css"
css_rtl_hash: "sha384-u0MzeBZZtzZYfm2QxXQbV14lVgTHrLKdF/uhQkWT4IYfJAPcyVsCOXVHSE9jDiYh"
js: "https://cdn.jsdelivr.net/npm/boosted@5.3.3/dist/js/boosted.min.js"
js: "https://cdn.jsdelivr.net/npm/ouds-web@0.1.0/dist/js/ouds-web.min.js"
js_hash: "sha384-TfjOlWccrKKSEc/hJqxs6Tofoh4+tlm//VJYb92Ow7aPNtgfaKuuLsnFqObi3xmp"
js_bundle: "https://cdn.jsdelivr.net/npm/boosted@5.3.3/dist/js/boosted.bundle.min.js"
js_bundle: "https://cdn.jsdelivr.net/npm/ouds-web@0.1.0/dist/js/ouds-web.bundle.min.js"
js_bundle_hash: "sha384-3RoJImQ+Yz4jAyP6xW29kJhqJOE3rdjuu9wkNycjCuDnGAtC/crm79mLcwj1w2o/"
popper: "https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.8/dist/umd/popper.min.js"
popper_hash: "sha384-I7E8VVD/ismYTF4hNIPjVp/Zjvgyol6VFvRkX/vR+Vc4jQkC+hVqc2pM8ODewa9r"
Expand Down
29 changes: 0 additions & 29 deletions site/assets/scss/_boosted.scss
Original file line number Diff line number Diff line change
Expand Up @@ -12,35 +12,6 @@ body {
min-height: 100vh;
}

//
// Boosted logo
//
// use HTML+CSS for Boosted 3D logo
// 1. Everything is em based, so we only play with font-size for RWD
#boosted {
width: 25em;
height: 25em;
font-size: 36%; // 1
box-shadow: -2em 2em $gray-600, -4em 4em $gray-300;
transform: rotateX(50deg) rotateY(0deg) rotateZ(-45deg) scale(.7);

@include media-breakpoint-up(sm) {
font-size: xx-small;
}

@include media-breakpoint-up(md) {
font-size: x-small;
}

@include media-breakpoint-up(lg) {
font-size: small;
}

@include media-breakpoint-up(xl) {
font-size: medium;
}
}

.display-0 {
font-size: 5.25em;
backface-visibility: hidden;
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ You can also use the CDN to fetch any of our [additional builds listed in the Co
- Read a bit more about some [important global environment settings](#important-globals) that Boosted utilizes.
- Read about what's included in Boosted in our [contents section]({{< docsref "/getting-started/contents/" >}}) and the list of [components that require JavaScript](#js-components) below.
- Need a little more power? Consider building with Boosted by [including the source files via package manager]({{< docsref "/getting-started/download#package-managers" >}}).
- Looking to use Boosted as a module with `<script type="module">`? Please refer to our [using Boosted as a module]({{< docsref "/getting-started/javascript#using-boosted-as-a-module" >}}) section.
- Looking to use Boosted as a module with `<script type="module">`? Please refer to our [using OUDS Web as a module]({{< docsref "/getting-started/javascript#using-ouds-web-as-a-module" >}}) section.

## JS components

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ A better alternative for those using this type of frameworks is to use a framewo
- Vue 3: [BootstrapVueNext](https://bootstrap-vue-next.github.io/bootstrap-vue-next/) (Bootstrap 5, currently in alpha)
- Angular: [ng-bootstrap](https://ng-bootstrap.github.io/)

## Using Boosted as a module
## Using OUDS Web as a module

{{< callout >}}
**Try it yourself!** Download the source code and working demo for using Bootstrap as an ES module from the [twbs/examples repository](https://github.com/twbs/examples/tree/main/sass-js-esm). You can also [open the example in StackBlitz](https://stackblitz.com/github/twbs/examples/tree/main/sass-js-esm?file=index.html).
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 3 additions & 1 deletion site/layouts/_default/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
{{ partial "home/css-variables" . }}
{{ partial "home/components-utilities" . }}
{{ partial "home/plugins" . }}
{{ partial "home/orange-design-system" . }}
<!--
{{ partial "home/orange-unified-design-system" . }}
-->
</div>
</main>

Expand Down
6 changes: 3 additions & 3 deletions site/layouts/partials/home/components-utilities.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</div>
<h2 class="mb-3 fw-semibold lh-sm">Components, meet the Utility&nbsp;API</h2>
<p class="lead fw-normal">
New in Boosted 5, our utilities are now generated by our <a href="/docs/{{ .Site.Params.docs_version }}/utilities/api/">Utility API</a>. We built it as a feature-packed Sass map that can be quickly and easily customized. It's never been easier to add, remove, or modify any utility classes. Make utilities responsive, add pseudo-class variants, and give them custom names.
New in OUDS Web, our utilities are now generated by our <a href="/docs/{{ .Site.Params.docs_version }}/utilities/api/">Utility API</a>. We built it as a feature-packed Sass map that can be quickly and easily customized. It's never been easier to add, remove, or modify any utility classes. Make utilities responsive, add pseudo-class variants, and give them custom names.
</p>
</div>
<div class="row gx-md-5">
Expand Down Expand Up @@ -61,8 +61,8 @@ <h3 class="fw-semibold">Quickly customize components</h3>
</div>
<div class="col-lg-6">
<h3 class="fw-semibold">Create and extend utilities</h3>
<p>Use Boosted's utility API to modify any of our included utilities or create your own custom utilities for any project. Import Boosted first, then use Sass map functions to modify, add, or remove utilities.</p>
{{ highlight (printf `@import "boosted/scss/boosted";
<p>Use OUDS Web's utility API to modify any of our included utilities or create your own custom utilities for any project. Import OUDS Web first, then use Sass map functions to modify, add, or remove utilities.</p>
{{ highlight (printf `@import "ouds-web/scss/ouds-web";

$utilities: map-merge(
$utilities,
Expand Down
4 changes: 2 additions & 2 deletions site/layouts/partials/home/css-variables.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</div>
<h2 class="mb-3 fw-semibold lh-sm">Build and extend in real-time with CSS&nbsp;variables</h2>
<p class="lead fw-normal">
Boosted 5 is evolving with each release to better utilize CSS variables for global theme styles, individual components, and even utilities. We provide dozens of variables for colors, font styles, and more at a <code>:root</code> level for use anywhere. On components and utilities, CSS variables are scoped to the relevant class and can easily be modified.
OUDS Web is evolving with each release to better utilize CSS variables for global theme styles, individual components, and even utilities. We provide dozens of variables for colors, font styles, and more at a <code>:root</code> level for use anywhere. On components and utilities, CSS variables are scoped to the relevant class and can easily be modified.
</p>
<p class="d-flex align-items-start flex-column lead fw-normal mb-0">
<a href="/docs/{{ .Site.Params.docs_version }}/customize/css-variables/" class="icon-link icon-link-hover fw-semibold mb-3">
Expand All @@ -31,7 +31,7 @@ <h3 class="fw-semibold">Using CSS variables</h3>
</div>
<div class="col-lg-6 mb-3">
<h3 class="fw-semibold">Customizing via CSS variables</h3>
<p>Override global, component, or utility class variables to customize Boosted just how you like. No need to redeclare each rule, just a new variable value.</p>
<p>Override global, component, or utility class variables to customize OUDS Web just how you like. No need to redeclare each rule, just a new variable value.</p>
{{ highlight (printf `body {
--bs-body-font-family: var(--bs-font-monospace);
--bs-body-line-height: 1.4;
Expand Down
38 changes: 19 additions & 19 deletions site/layouts/partials/home/customize.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</div>
<h2 class="mb-3 fw-semibold lh-sm">Customize everything with&nbsp;Sass</h2>
<p class="lead fw-normal">
Boosted utilizes Sass for a modular and customizable architecture. Import only the components you need, enable global options like gradients and shadows, and write your own CSS with our variables, maps, functions, and mixins.
OUDS Web utilizes Sass for a modular and customizable architecture. Import only the components you need, enable global options like gradients and shadows, and write your own CSS with our variables, maps, functions, and mixins.
</p>
<p class="d-flex justify-content-start lead fw-normal">
<a href="/docs/{{ .Site.Params.docs_version }}/customize/overview/" class="icon-link icon-link-hover fw-semibold">
Expand All @@ -16,44 +16,44 @@ <h2 class="mb-3 fw-semibold lh-sm">Customize everything with&nbsp;Sass</h2>

<section class="row g-lg-5 mb-5 pb-md-5">
<div class="col-lg-6">
<h3>Include all of Boosted’s Sass</h3>
<h3>Include all of OUDS Web's Sass</h3>
<p>Import one stylesheet and you're off to the races with every feature of our CSS.</p>
{{ highlight (printf `// Variable overrides first
$primary: #900;
$enable-shadows: true;
$prefix: "mo-";

// Then import Boosted
@import "../node_modules/boosted/scss/boosted";
// Then import OUDS Web
@import "../node_modules/ouds-web/scss/ouds-web";
`) "scss" "" }}
<p>Learn more about our <a href="/docs/{{ .Site.Params.docs_version }}/customize/options/">global Sass options</a>.</p>
</div>
<div class="col-lg-6">
<h3>Include what you need</h3>
<p>The easiest way to customize Boosted—include only the CSS you need.</p>
<p>The easiest way to customize OUDS Web—include only the CSS you need.</p>
{{ highlight (printf `// Functions first
@import "../node_modules/boosted/scss/functions";
@import "../node_modules/ouds-web/scss/functions";

// Variable overrides second
$primary: #900;
$enable-shadows: true;
$prefix: "mo-";

// Required Boosted imports
@import "../node_modules/boosted/scss/variables";
@import "../node_modules/boosted/scss/variables-dark";
@import "../node_modules/boosted/scss/maps";
@import "../node_modules/boosted/scss/mixins";
@import "../node_modules/boosted/scss/root";
// Required OUDS Web imports
@import "../node_modules/ouds-web/scss/variables";
@import "../node_modules/ouds-web/scss/variables-dark";
@import "../node_modules/ouds-web/scss/maps";
@import "../node_modules/ouds-web/scss/mixins";
@import "../node_modules/ouds-web/scss/root";

// Optional components
@import "../node_modules/boosted/scss/utilities";
@import "../node_modules/boosted/scss/reboot";
@import "../node_modules/boosted/scss/containers";
@import "../node_modules/boosted/scss/grid";
@import "../node_modules/boosted/scss/helpers";
@import "../node_modules/boosted/scss/utilities/api";
@import "../node_modules/ouds-web/scss/utilities";
@import "../node_modules/ouds-web/scss/reboot";
@import "../node_modules/ouds-web/scss/containers";
@import "../node_modules/ouds-web/scss/grid";
@import "../node_modules/ouds-web/scss/helpers";
@import "../node_modules/ouds-web/scss/utilities/api";
`) "scss" "" }}
<p>Learn more about <a href="/docs/{{ .Site.Params.docs_version }}/customize/sass/">using Boosted with Sass</a>.</p>
<p>Learn more about <a href="/docs/{{ .Site.Params.docs_version }}/customize/sass/">using OUDS Web with Sass</a>.</p>
</div>
</section>
12 changes: 6 additions & 6 deletions site/layouts/partials/home/get-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</div>
<h2 class="mb-3 lh-sm fw-semibold">Get started any way you&nbsp;want</h2>
<p class="lead fw-normal">
Jump right into building with Boosted—use the CDN, install it via package manager, or download the source code.
Jump right into building with OUDS Web—use the CDN, install it via package manager, or download the source code.
</p>
<p class="d-flex justify-content-md-start justify-content-md-center lead fw-normal">
<a href="/docs/{{ .Site.Params.docs_version }}/getting-started/download/" class="icon-link icon-link-hover fw-semibold ps-md-4">
Expand All @@ -19,10 +19,10 @@ <h2 class="mb-3 lh-sm fw-semibold">Get started any way you&nbsp;want</h2>
<svg class="bi mb-2 fs-2 text-body-secondary"><use xlink:href="#box-seam"></use></svg>
<h3 class="fw-semibold">Install via package manager</h3>
<p class="pe-lg-5">
Install Boosted’s source Sass and JavaScript files via npm, yarn, Composer, or NuGet. Package managed installs dont include documentation or our full build scripts.
Install OUDS Web's source Sass and JavaScript files via npm, yarn, Composer, or NuGet. Package managed installs don't include documentation or our full build scripts.
</p>
{{ highlight (printf ("npm install boosted@%s") .Site.Params.current_version) "sh" "" }}
{{ highlight (printf ("yarn add boosted@%s") .Site.Params.current_version) "sh" "" }}
{{ highlight (printf ("npm install ouds-web@%s") .Site.Params.current_version) "sh" "" }}
{{ highlight (printf ("yarn add ouds-web@%s") .Site.Params.current_version) "sh" "" }}
<p>
<a href="/docs/{{ .Site.Params.docs_version }}/getting-started/download/">Read our installation docs</a> for more info and additional package managers.
</p>
Expand All @@ -31,15 +31,15 @@ <h3 class="fw-semibold">Install via package manager</h3>
<svg class="bi mb-2 fs-2 text-body-secondary"><use xlink:href="#globe2"></use></svg>
<h3 class="fw-semibold">Include via CDN</h3>
<p class="pe-lg-5">
When you only need to include Boosted’s compiled CSS or JS, you can use <a href="https://www.jsdelivr.com/package/npm/boosted">jsDelivr</a>. See it in action with our simple <a href="/docs/{{ .Site.Params.docs_version }}/getting-started/introduction/#quick-start">quick start</a>, or <a href="/docs/{{ .Site.Params.docs_version }}/examples/">browse the examples</a> to jumpstart your next project. You can also choose to include Popper and our JS <a href="/docs/{{ .Site.Params.docs_version }}/getting-started/introduction/#separate">separately</a>.
When you only need to include OUDS Web's compiled CSS or JS, you can use <a href="https://www.jsdelivr.com/package/npm/uds-web">jsDelivr</a>. See it in action with our simple <a href="/docs/{{ .Site.Params.docs_version }}/getting-started/introduction/#quick-start">quick start</a>, or <a href="/docs/{{ .Site.Params.docs_version }}/examples/">browse the examples</a> to jumpstart your next project. You can also choose to include Popper and our JS <a href="/docs/{{ .Site.Params.docs_version }}/getting-started/introduction/#separate">separately</a>.
</p>
{{ highlight (printf (`<link href="%s" rel="stylesheet" integrity=%q crossorigin="anonymous">`) .Site.Params.cdn.css (.Site.Params.cdn.css_hash | safeHTMLAttr)) "html" "" }}
{{ highlight (printf (`<script src="%s" integrity=%q crossorigin="anonymous"></script>`) .Site.Params.cdn.js_bundle (.Site.Params.cdn.js_bundle_hash | safeHTMLAttr)) "html" "" }}
</div>

<div class="col-md-8 mx-auto text-center">
<h4 class="fw-semibold">Read our getting started guides</h4>
<p>Get a jump on including Boosted's source files in a new project with our official guides.</p>
<p>Get a jump on including OUDS Web's source files in a new project with our official guides.</p>
<div class="d-flex flex-wrap align-items-center justify-content-center gap-4 mt-4">
<a class="d-flex flex-column align-items-center text-decoration-none animate-img" href="/docs/{{ .Site.Params.docs_version }}/getting-started/webpack/">
<img class="d-block mb-2" src="/docs/{{ .Site.Params.docs_version }}/assets/img/webpack.svg" alt="" width="72" height="72" loading="lazy">
Expand Down
Loading

0 comments on commit b0787f7

Please sign in to comment.