Skip to content

Latest commit

 

History

History
124 lines (107 loc) · 5.51 KB

File metadata and controls

124 lines (107 loc) · 5.51 KB
layout title description group aliases toc
docs
Contents
Discover what's included in OUDS Web, including our compiled and source code flavors.
getting-started
/docs/getting-started/contents/
true

Compiled OUDS Web

Once downloaded, unzip the compressed folder and you'll see something like this:

ouds-web/
├── css/
│   ├── ouds-web-bootstrap.css
│   ├── ouds-web-bootstrap.css.map
│   ├── ouds-web-bootstrap.min.css
│   ├── ouds-web-bootstrap.min.css.map
│   ├── ouds-web-bootstrap.rtl.css
│   ├── ouds-web-bootstrap.rtl.css.map
│   ├── ouds-web-bootstrap.rtl.min.css
│   ├── ouds-web-bootstrap.rtl.min.css.map
│   ├── ouds-web-grid.css
│   ├── ouds-web-grid.css.map
│   ├── ouds-web-grid.min.css
│   ├── ouds-web-grid.min.css.map
│   ├── ouds-web-grid.rtl.css
│   ├── ouds-web-grid.rtl.css.map
│   ├── ouds-web-grid.rtl.min.css
│   ├── ouds-web-grid.rtl.min.css.map
│   ├── ouds-web-reboot.css
│   ├── ouds-web-reboot.css.map
│   ├── ouds-web-reboot.min.css
│   ├── ouds-web-reboot.min.css.map
│   ├── ouds-web-reboot.rtl.css
│   ├── ouds-web-reboot.rtl.css.map
│   ├── ouds-web-reboot.rtl.min.css
│   ├── ouds-web-reboot.rtl.min.css.map
│   ├── ouds-web-utilities.css
│   ├── ouds-web-utilities.css.map
│   ├── ouds-web-utilities.min.css
│   ├── ouds-web-utilities.min.css.map
│   ├── ouds-web-utilities.rtl.css
│   ├── ouds-web-utilities.rtl.css.map
│   ├── ouds-web-utilities.rtl.min.css
│   ├── ouds-web-utilities.rtl.min.css.map
│   ├── ouds-web.css
│   ├── ouds-web.css.map
│   ├── ouds-web.min.css
│   ├── ouds-web.min.css.map
│   ├── ouds-web.rtl.css
│   ├── ouds-web.rtl.css.map
│   ├── ouds-web.rtl.min.css
│   └── ouds-web.rtl.min.css.map
└── js/
    ├── ouds-web.bundle.js
    ├── ouds-web.bundle.js.map
    ├── ouds-web.bundle.min.js
    ├── ouds-web.bundle.min.js.map
    ├── ouds-web.esm.js
    ├── ouds-web.esm.js.map
    ├── ouds-web.esm.min.js
    ├── ouds-web.esm.min.js.map
    ├── ouds-web.js
    ├── ouds-web.js.map
    ├── ouds-web.min.js
    └── ouds-web.min.js.map

This is the most basic form of OUDS Web: compiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (ouds-web.*), as well as compiled and minified CSS and JS (ouds-web.min.*). Source maps (ouds-web.*.map) are available for use with certain browsers' developer tools. Bundled JS files (ouds-web.bundle.js and minified ouds-web.bundle.min.js) include Popper.

We also provide a compiled and minified CSS (ouds-web-bootstrap.* and ouds-web-bootstrap.min.*) enforcing Bootstrap compatibility.

CSS files

OUDS Web includes a handful of options for including some or all of our compiled CSS.

{{< bs-table "table" >}}

CSS files Layout Content Components Utilities
ouds-web.css
ouds-web.min.css
ouds-web.rtl.css
ouds-web.rtl.min.css
Included Included Included Included without Bootstrap utilities
ouds-web-bootstrap.css
ouds-web-bootstrap.min.css
ouds-web-bootstrap.rtl.css
ouds-web-bootstrap.rtl.min.css
Included Included Included Included with Bootstrap utilities
ouds-web-grid.css
ouds-web-grid.rtl.css
ouds-web-grid.min.css
ouds-web-grid.rtl.min.css
[Only grid system]({{< docsref "/layout/grid" >}}) [Only flex utilities]({{< docsref "/utilities/flex" >}})
ouds-web-utilities.css
ouds-web-utilities.rtl.css
ouds-web-utilities.min.css
ouds-web-utilities.rtl.min.css
Included
ouds-web-reboot.css
ouds-web-reboot.rtl.css
ouds-web-reboot.min.css
ouds-web-reboot.rtl.min.css
[Only Reboot]({{< docsref "/content/reboot" >}})
{{< /bs-table >}}

JS files

Similarly, we have options for including some or all of our compiled JavaScript.

{{< bs-table "table" >}}

JS Files :focus-visible Polyfill Popper
ouds-web.bundle.js
ouds-web.bundle.min.js
Included Included
ouds-web.js
ouds-web.min.js
Included
{{< /bs-table >}}

OUDS Web source code

The OUDS Web source code download includes the compiled CSS and JavaScript assets, along with source Sass, JavaScript, and documentation. More specifically, it includes the following and more:

ouds-web/
├── dist/
│   ├── css/
│   └── js/
├── site/
│   └──content/
│      └── docs/
│          └── {{< param docs_version >}}/
│              └── examples/
├── js/
└── scss/

The scss/ and js/ are the source code for our CSS and JavaScript. The dist/ folder includes everything listed in the compiled download section above. The site/content/docs/ folder includes the source code for our hosted documentation, including our live examples of OUDS Web usage.

Beyond that, any other included file provides support for packages, license information, and development.