@ouds/web-sosh

Table of contents

- Quick start
- What’s included
- Bugs and feature requests
- Documentation
- Contributing
- Versioning
- Copyright and license

Quick start

This package is not intended to be used alone. Please read our main README to know more.

What’s included

Within the download you’ll find the following directories and files, logically grouping common assets and providing both compiled and minified variations.

We provide compiled CSS (ouds-web.), as well as compiled and minified CSS (ouds-web.min.). Source maps (ouds-web.*.map) are available for use with certain browsers’ developer tools.

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

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

OUDS Web’s documentation, included in this repo in the root directory, is built with Astro and publicly hosted on GitHub Pages at . The docs may also be run locally.

Documentation search is powered by Algolia’s DocSearch.

$3

1. Run npm install from the root /ouds-web directory, to install the Node.js dependencies, including Astro (the site builder).
2. Run npm run css from the brand root /ouds-web/packages/sosh directory, (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
3. From the root /ouds-web/packages/sosh directory, run npm run astro-dev` in the command line.
4. Open in your browser, and voilà.

Learn more about using Astro by reading its documentation.

$3

You can find all our previous releases docs on .

Previous releases and their documentation are also available for download.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at .

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, OUDS Web is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

See the Releases section of our GitHub project for changelogs for each release version of OUDS Web.

Our default branch is for development of our OUDS Web release.

Copyright and license

Code and documentation copyright 2011-2025 the Bootstrap Authors. Code released under the MIT License. Docs released under Creative Commons.

OUDS Web code and documentation copyright 2015-2025 the OUDS Web Authors and Orange SA. Code released under the MIT License. Docs released under Creative Commons.