# EdGEL: The University of Edinburgh Design System

> **EdGEL version <version>5.0.0-alpha.1</version>**

A [Bootstrap 5](https://getbootstrap.com) theme implementing the University 
of Edinburgh Design System.

This is still pre-release and not yet ready for production use.

## What's included

```
.
├── dist       # The compiled CSS, JS and other page assets 
├── js         # The source Javascript.  Requires Bootstrap source JS.
├── scss       # EdGEL web components (experimental)
└── templates  # Compiled JS and CSS to use in other projects
```

We provide compiled CSS and JS (`dist/css/edgel-*.css`, `dist/js/edgel-*.js`),
as well as compiled and minified CSS and JS (`dist/css/edgel-*.min.css`, 
`dist/js/edgel-*.min.js`). 

[Source maps](https://developers.google.com/web/tools/chrome-devtools/javascript/source-maps)
(`*.map` files) are available for use with certain browsers' developer tools. 

Bundled JS files (`dist/js/edgel.bundle.js` and minified `dist/js/edgel.bundle.min.js`) 
include [Popper](https://popper.js.org/).

## Fonts
This package includes the fonts 
[Source Sans Pro](https://fonts.google.com/specimen/Source+Sans+Pro) and 
[Crimson Text](https://fonts.google.com/specimen/Crimson+Text) licensed under the
[Open Font License](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL)
