Skip to content

Latest commit

 

History

History
126 lines (85 loc) · 3.73 KB

README-jp.md

File metadata and controls

126 lines (85 loc) · 3.73 KB
Raw

NES.cssは ファミコン風(8bit ライク) なCSSフレームワークです。

Gitter Commitizen friendly

Install

CDN

<!-- minify -->
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.min.css" rel="stylesheet" />
<!-- latest -->
<link href="https://unpkg.com/nes.css/css/nes.min.css" rel="stylesheet" />

OR

<!-- non-minified -->
<link href="https://unpkg.com/nes.css@0.0.2/css/nes.css" rel="stylesheet" />
<!-- latest -->
<link href="https://unpkg.com/nes.css/css/nes.css" rel="stylesheet" />

npm

TODO: npm での使用方法を書く

Usage

NES.cssはコンポーネントのスタイルのみを提供しています。レイアウトはみなさんが好きなように定義してください。

デフォルトのフォントはPress Start 2Pを使っています。英語以外（日本語など）で利用される場合は、別途フォントを読み込んで使ってください。 フォントを読み込む方法は、Google FontsのGet Startedを参照するか、または以下のように読み込んでください。

<head>
    <link href="https://fonts.googleapis.com/css?family=Press+Start+2P" rel="stylesheet">
    <link href="https://unpkg.com/nes.css/css/nes.css" rel="stylesheet" />
    <style>
      html, body, pre, code, kbd, samp {
          font-family: "font-family you want to use";
      }
    </style>    
</head>

Recommended Fonts

言語 フォント
(デフォルト) Press Start 2P
英語 Kongtext
日本語 美咲フォント
日本語 Nu もち

CSS Only

NES.cssはCSSのみで構成されています。JavaScriptは不要です。

Browser Support

次のブラウザの最新バージョンをサポートしています。

  • Chrome
  • Firefox
  • Safari

未確認

  • IE/Edge

Development

Commands

git clone git@github.com:BcRikko/NES.css.git
cd NES.css

npm i

npm run watch
npm run build

pre-commit hookにより、コミット時に自動でLint→format→buildが走り、cssディレクトリにファイルが出力されます。 TODO: ビルドはCIでするように変更したい

Directories

.
├── index.html: Demo page
├── style.css: Demo page style
├── css: Distribution files
└── scss: Source
    ├── base
    │   ├── reboot.scss: Don't change! (Bootstrap Reboot)
    │   ├── generic.scss: Generic style and reboot.css
    │   └── variables.scss: Common variables
    ├── elements
    ├── form
    ├── icons: 16x16 icons
    ├── pixel-arts: For icons other than 16x16.
    └── utilities

Copyright and license

Code and documentation copyright 2018 B.C.Rikko. Code released under the MIT License. Docs released under Creative Commons.