An open API service indexing awesome lists of open source software.

https://github.com/openspending/os-styles

Stylesheets used by OpenSpending
https://github.com/openspending/os-styles

Last synced: about 1 month ago
JSON representation

Stylesheets used by OpenSpending

Awesome Lists containing this project

README

          

# OS Styles

SCSS for the OpenSpending websites/web apps (WIP).

- Built on Bootstrap, adapted from [previous](https://github.com/openspending/os-style-guide) [Bourbon](http://bourbon.io/) version.
- Generates four stylesheets, each using a different accent colour, acording to the sub-brand.

Example usage: https://github.com/smth/os-mockups

## Usage

Install this package using `npm` (you can install the GitHub repository
directly), and then you can `@import` the stylesheets you need. The caveat is
that many stylesheets use external asset files (e.g. fonts or images), which
need to be made available by your webserver.

To do so, you need to copy the contents of the `src/assets` folder somewhere
your webserver can serve them, and change the `$assets-path` variable to where
this folder is available relative to your stylesheets. For example, imagine
we're in a project that has installed `os-styles` via `npm`, and we want to
import its stylesheets. You'd do:

```sass
@import "node_modules/os-styles/src/variables";

$assets-path: "/assets";

@import "node_modules/os-styles/src/base";

// Continue with my custom styles...
```

This means that the stylesheets would expect the assets to be available on
`http://example.com/assets` (considering the website lives in
`http://example.com`). You have to make the contents of
`node_modules/os-styles/src/assets` available at that location.