euphoria

3.5.0 • Public • Published

Euphoria Banner

styled with prettier Travis CI build status Dependency Status View on npm View on npm

A euphoric CSS micro-framework.

Quick Start

To try out Euphoria, just add the following to the <head> of your page:

<link href="//unpkg.com/euphoria/dist/euphoria.min.css" rel="stylesheet" type="text/css" />

Now check the documentation site for usage information.

Installation

CDN

The easiest way to use Euphoria in a new project is to just include the unpkg file above.

Using npm/yarn

Install Euphoria:

# Using npm 
npm install --save euphoria
 
# Using yarn 
yarn add euphoria

Now you can either include the minified files in your CSS:

@import './node_modules/euphoria/dist/euphoria.min.css';

Or, if you are using PostCSS, you can import the source files which will give you access to the CSS variables that Euphoria provides:

@import './node_modules/euphoria/src/euphoria.css';

If you are using a tool like WebPack, you can use a shorter import syntax:

@import '~euphoria';

Customizing Euphoria

To customize Euphoria, import the CSS and then change the values of the CSS variables. Please see the available variables that Euphoria creates.

Contributing

Pull Requests welcome!

Checkout the project and run:

# Using nvm, install proper node version. 
nvm install
nvm use
 
# Install dependencies. 
npm install
 
# Run dev server: 
npm start

Once you're happy with your changes, submit a Pull Request on Github.

Formatting

Please run Prettier (use npm run format if your editor isn't setup to use Prettier) on all code before submitting.

Changelog

Please see changelog.md

Credits

Copyright © 2018 by Dana Woodman.

Inspiration

Euphoria was inspired by a lot of awesome projects, including:

Thank you to all those that have put in a lot of thought and energy around pushing CSS forward!

License

MIT

Dependents (0)

Package Sidebar

Install

npm i euphoria

Weekly Downloads

104

Version

3.5.0

License

MIT

Unpacked Size

396 kB

Total Files

75

Last publish

Collaborators

  • danawoodman