Skip to content

Latest commit

 

History

History
98 lines (61 loc) · 4.06 KB

README.md

File metadata and controls

98 lines (61 loc) · 4.06 KB

Umi

Build Status by Travis CI devDependency Status The MIT License npm

https://ysakasin.github.io/Umi/

Umi

"Umi" は "Honoka"を元にした日本語も美しく表示できるBootstrapテーマです。

About "Umi"

通常の Bootstrap では、日本語の表示が最適であるとはいえません。 "Honoka" では Bootstrap をベースに、日本語表示に適したフォントの指定や、ウェイトに関するコードを追記した Bootstrap テーマです。

"Umi"は"Honoka"にBootswatch Flatlyの配色を適応したテーマです。

Live Demo

Getting Started

Download

Releases ページから最新版をダウンロードしてください。

npm

Node.js のパッケージ管理システムである、 npm公開されていますwebpack など、npmを利用したmodule bundlerでご利用ください。

npm install --save bootstrap-umi

パッケージ名が「**bootstrap-**umi」であることに注意してください。

Bower

Bower からインストールすることができます。

最新版をインストールするには以下のコマンドを実行してください。

bower install --save-dev $(node -e "$(curl -fsSL https://cdn.honokak.osaka/last.js)" ysakasin Umi)

もしcURLが入っていない環境の場合には、

bower install --save-dev Umi#(version)

(version) には Umi のバージョン番号を指定します(ex. Umi#4.0.0)。 Umi の最新バージョン番号は Releases ページから確認してください。

Usage

Umi は Bootstrap のテーマにしか過ぎないため、基本的な使い方は Bootstrap と変わりません。 Bootstrap のスタイルシートの読み込みを Umi のスタイルシートに置き換えることで動作します。また JavaScript のコードは変更されていないので、 Bootstrap のものを使っても問題ありません。

そのほか Bootstrap の機能の詳細については Bootstrap のドキュメント を参照してください。

Package

配布している ZIP ファイルの内容物は以下のとおりです。 bootstrap.min.css といったように、ファイル名に min がついているファイルは、改行やインデント・スペーシングをなくした(minifyされた)コードで、ユーザがウェブページを読み込む際の転送量を少なくすることができます。通常はこの bootstrap.min.* を使うことをおすすめします。

umi/
├─ LICENSE
├─ README.md
├─ bootstrap.html
├─ css/
│  ├─ bootstrap.css
│  └─ bootstrap.min.css
└─ js/
    ├─ bootstrap.bundle.js
    ├─ bootstrap.bundle.min.js
    ├─ bootstrap.js
    └─ bootstrap.min.js

Build

ビルドの方法については Wiki をご覧ください。

License

MIT License

Author of "Honoka"

Editor of "Umi"