Chirno NPM | npm.io

Chirno Projectについて

Bootstrap Chirno Project (ブートストラップ・チルノ　プロジェクト)は、フロントエンドフレームワーク「Bootstrap」バージョン4の日本語化プロジェクトです。

Chirno Projectは、主に2つの活動を主軸にします。

日本語文書に最適化したBootstrapの改良
Bootstrap Documentations(説明書)の日本語化

翻訳に協力して頂ける方、大歓迎です。貢献についてお読みください。

Chirnoという名前は、上海アリス幻樂団が発表している弾幕ゲームシリーズ「東方Project」の人気キャラクター「チルノ」に由来します。

また、このプロジェクトは、Honokaをリスペクトして作成しました。

開発ロードマップ

まだ個人開発なので策定予定はないです…
本家のほうはそこそこはっきりしてるので追従していきます。

クイック・スタート

Chirnoをはじめる

Chirnoを簡単に始めるには、いくつかの選択肢があります :

最新のリリースをダウンロード。
リポジトリをClone: git clone https://github.com/9-chirno/chirno.git
npm: npm install churno@4.0.0-chirno17548
yarn: yarn add chirno@4.0.0-chirno17548
Composer: composer require 9-chirno/chirno:4.0.0-chirno17548

NuGetへの対応は当面ありません

bootstrapをはじめるを読んでください。テンプレートや利用例、フレームワークができること等が書かれています。

本家Bootstrapをはじめる

Bootstrapを簡単に始めるには、いくつかの選択肢があります :

最新のリリースをダウンロード。
リポジトリをClone: git clone https://github.com/twbs/bootstrap.git
npm: npm install bootstrap@4.0.0-chirno17548
yarn: yarn add bootstrap@4.0.0-chirno17548
Composer: composer require twbs/bootstrap:4.0.0-chirno17548
NuGet: CSS: Install-Package bootstrap -Pre Sass: Install-Package bootstrap.sass -Pre (-Pre はbootstrap v4が安定版になったら不要となります)

Bootstrapをはじめるを読んでください。テンプレートや利用例、フレームワークができること等が書かれています。

状態

同梱品一覧

ダウンロードしたZipフォルダの中は、以下のようになっています。

bootstrap/
├── css/
│   ├── bootstrap.css
│   ├── bootstrap.css.map
│   ├── bootstrap.min.css
│   ├── bootstrap.min.css.map
│   ├── bootstrap-grid.css
│   ├── bootstrap-grid.css.map
│   ├── bootstrap-grid.min.css
│   ├── bootstrap-grid.min.css.map
│   ├── bootstrap-reboot.css
│   ├── bootstrap-reboot.css.map
│   ├── bootstrap-reboot.min.css
│   └── bootstrap-reboot.min.css.map
└── js/
    ├── bootstrap.bundle.js
    ├── bootstrap.bundle.min.js
    ├── bootstrap.js
    └── bootstrap.min.js

コンパイルされたjsとcss(bootstrap.*)、そしてコンパイルと最小化を施したもの(bootstrap.min.*)があります。CSSソースマップ (bootstrap.*.map)は、ブラウザのF12デベロッパーツールでデバッグ等をするときに役立ちます。バンドルされたJSファイル(bootstrap.bundle.jsと最小化されたbootstrap.bundle.min.js)はPopperを含んでいますがjQueryは含んでいません。

バグ報告と機能追加要望

バグ報告や、機能追加の要望がありますか？
まずissueガイドラインを読んで、既存のissueを検索し、同じ報告がないか確認してください。
探してないようであれば、issueを開いてください。

説明書

このリポジトリのルートディレクトリにある説明書は、Jekyllで作られ、GitHub Pagesでホスティングされています: https://getbootstrap.com。
この説明書は、ローカル環境でも機能します。

説明書の検索機能はAlgolia's DocSearchによって動作しています。

説明書をローカルで見る

Tooling Setupを読みながら、bundle installを実行してください。Jekyll(サイトを動かすソフトウェア)やその他のRubyで書かれた必要なパッケージがインストールされます。
npm installを実行します。JavaScriptで書かれた必要なパッケージがインストールされます。
npm run testを実行します。サイトがビルドされます。
さいごに、npm run docs-serveを実行します。
http://localhost:9001をブラウザで開きましょう。

Jekyllについてはこちらをご覧ください: Jekyll ドキュメンテーション (英語)
またはJekyll 日本語訳

過去のバージョンの説明書

v2.3.2: https://getbootstrap.com/2.3.2/ (英語)
v3.3.x: https://getbootstrap.com/docs/3.3/ (英語)

Chirnoの更新とその説明書はリンク先で確認できます。

貢献

CONTRIBUTING.mdを必ず読んでください。

プルリクエストには、関連したユニットテストの結果が必要です。すべてのHTMLとCSSは、Mark Otto氏が執筆するCode Guideに準拠していなければなりません。

記述様式についてはeditor configを参照してください。アドオン等他の詳細な情報は: http://editorconfig.org

コミュニティ

開発者とユーザーのコミュニティです

本家 (英語)

@getbootstrap on Twitterをフォロー
The Official Bootstrap Blogを購読
オフィシャルSlackに入室
IRCでチャットしましょう。irc.freenode.netサーバーの##bootstrapチャンネルです。
実装に関する疑問はStack Overflow (bootstrap-4 タグ)で解決できるかもしれません。
Chirnoのような、bootstrapから派生したパッケージは、npmやパッケージ管理サービスに登録するとき、キーワードにbootstrapを入れてください。