https://github.com/pepabo/nachiguro

SUZURI CSS Framework
https://github.com/pepabo/nachiguro

Last synced: about 1 month ago
JSON representation

SUZURI CSS Framework

• Host: GitHub
• URL: https://github.com/pepabo/nachiguro
• Owner: pepabo
• License: mit
• Created: 2020-02-28T00:40:04.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-12T04:46:55.000Z (6 months ago)
• Last Synced: 2024-07-12T08:46:56.423Z (6 months ago)
• Language: SCSS
• Homepage: https://pepabo.github.io/nachiguro/
• Size: 19.7 MB
• Stars: 13
• Watchers: 10
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Nachiguro

[SUZURI](https://suzuri.jp) CSS Framework

### Installation

This package is not yet published on npm.

```

npm install -D pepabo/nachiguro

```

#### Assets prefix

Nachiguro includes some images for background properties. They will be compiled to:

```css

background: url('nachiguro/assets/images/indicator-eyes.gif');

```

Depending your application structure, it can't be referenced correctly when loaded on browser. To solve this you change `nachiguro/assets/` prefix by assigning `$ncgr-assets-prefix`.

```scss

$ncgr-assets-prefix: 'path/to/public/nachiguro/assets/';

@import 'nachiguro';

```

#### Use with sprockets

If you use nachiguro with Rails application and it uses sprockets, `nachiguro-sprockets` have to be imported before `nachiguro`. This replaces `url` with `asset-url`.

```scss

@import 'nachiguro-sprockets';

@import 'nachiguro';

```

#### Styleguide

If you want to update and read the styleguide, run the following command to open the `styleguide/index.html` in your browser.

```

npm run styleguide

```

Since hologram is installed via bundler, please run `bundle install` if you can't run hologram.