csstalk / website

1 stars 0 forks source link

CSS Talk website

CSSをテーマにした勉強会「CSS Talk」の公式サイトのリポジトリです。

インストール

開発に必要なパッケージなどは以下のコマンドですべてインストールされます。クローンをしたあとに実行してください。

npm install

推奨環境

以下の環境で動作の確認をしています。

ファイル構成

開発は/srcディレクトリでおこない、/docsディレクトリに出力されます。

├── README.md
├── aigis/ // スタイルガイドのテンプレート
├── docs/ // 本番公開用のディレクトリ
├── gulpfile.babel.js // Gulpの設定ファイル
├── package.json // Node.jsの設定ファイル
└── src/ // 開発用のディレクトリ
    ├── _data/ // JSONファイル
    ├── _includes/ // Pugのテンプレートファイル
    ├── assets/ // サイト共通のファイル
    │   ├── css/ // CSSファイル
    │   ├── icon/ // アイコンフォント用のSVG
    │   │   └── template/ // アイコンフォント用のテンプレートファイル
    │   │       ├── _icon.css
    │   │       └── _icon.html
    │   ├── img/ // 画像ファイル
    │   └── js/ // JavaScriptファイル
    └── index.pug // Pugファイル

開発タスク

以下のコマンドを実行すると、開発に必要なGulpのタスクがすべて実行されます。

npm start

以下のような処理がおこなわれます。

スタイルガイドのインデックスページは/src/assets/css/styleguide/index.mdに記述されています。監視対象にはなっていないので、すぐに更新したいときは以下のコマンドを実行してください。

npm run styleguide

公開URL

/docsディレクトリはhttps://csstalk.net/として公開されます。