epfl-theme-elements/README.md

EPFL Web 2018 Styleguide based on elements

<p align="center">
  <a href="https://web2018.epfl.ch">
    <img src="https://raw.githubusercontent.com/epfl-si/epfl-theme-elements/master/docs/readme/logo.png" alt="EPFL Theme Elements logo" width="100" height="100">
  </a>
</p>

<h3 align="center">
  EPFL Theme Elements
</h3>

<p align="center">
  EPFL Web2018 Theme based on Elements.
</p>

<p align="center">
  <a href="https://github.com/epfl-si/epfl-theme-elements/actions/workflows/test.yml">
    <img alt="Test Status" src="https://github.com/epfl-si/epfl-theme-elements/actions/workflows/test.yml/badge.svg?branch=master">
  </a>
  <a href="https://github.com/epfl-si/epfl-theme-elements/actions/workflows/build.yml">
    <img alt="Build Status" src="https://github.com/epfl-si/epfl-theme-elements/actions/workflows/build.yml/badge.svg?branch=master">
  </a>
  <a href="https://www.npmjs.com/package/epfl-theme-elements">
    <img alt="npm version" src="https://img.shields.io/npm/v/epfl-theme-elements.svg" />
  </a>
</p>

---

Documentation
-------------

* [EPFL Theme Elements](https://github.com/epfl-si/epfl-theme-elements/wiki)
* [Elements](https://epfl-si.github.io/elements/#/)
* [Bootstrap](https://getbootstrap.com/)

Quick start
-----------

Several quick start options are available:

* [Web2018 CDN](https://github.com/epfl-si/epfl-theme-elements/wiki/Web2018-CDN)
* [Download the latest release](https://github.com/epfl-si/epfl-theme-elements/releases/latest)
* Install with [npm](https://www.npmjs.com/package/epfl-theme-elements): `npm install epfl-theme-elements`
* Install with [yarn](https://yarnpkg.com/en/package/epfl-theme-elements): `yarn add epfl-theme-elements`

Read the [Wiki](https://github.com/epfl-si/epfl-theme-elements/wiki/Technical-documentation)
for more information.

What's included
---------------

Within the download you'll find the following directories and files,
logically grouping common assets and providing minified versions.
You'll see something like this:

```
dist/
├──css/
│  └── elements.min.css
├──icons/
│  ├── apple-touch-icon.png
│  ├── epfl-logo.png
│  ├── epfl-logo.svg
│  ├── epfl-logo-negative.svg
│  ├── favicon-16.png
│  ├── favicon-32.png
│  ├── favicon.ico
|  ├── feather-sprite.svg
│  ├── icons.svg
│  └── square.png
├──images/
│  └── icons/
│      ├── icon-course-exercise.svg
│      ├── icon-course-project.svg
│      └── icon-teaser-video.svg
└──js/
   ├── elements.min.js.LICENSE.txt
   ├── elements.min.js
   └── vendors.min.js.LICENSE.txt
```

Applications Showcase
---------------------

* [Actu](https://actu.epfl.ch)
* [Media Library](https://mediatheque.epfl.ch/)
* [Memento](https://memento.epfl.ch)
* [Press review](https://rdp.epfl.ch)

Contributing
------------

Contributions are always welcome.

See [Contributing](CONTRIBUTING.md).

Versioning
----------

EPFL Theme Elements is maintained under the Semantic Versioning guidelines.

Developers
----------

* [Olivier Bieler](https://github.com/obieler)
* [William Belle](https://github.com/williambelle)