-
Notifications
You must be signed in to change notification settings - Fork 48
ドキュメントサイトに最低限の文章と画像を追加 #14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| yarn | ||
|
|
||
| ```bash | ||
| yarn add -D @charcoal/icons |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
icons は devDependencies 推奨ではなさそう
|
|
||
| ``` | ||
| npm i @charcoal/theme | ||
| npm i --save-dev @charcoal/theme |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
こっちも間違っていた
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
|
|
||
| `@charcoal` is using [commintlint](https://github.com/conventional-changelog/commitlint) and | ||
| following the [Conventional Commits](https://www.conventionalcommits.org/ja/v1.0.0/) rules. | ||
| ## charcoal のはじめ方 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
大文字小文字表記が揺れているのでルールがあったほうが良さそう
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
最初は大文字の気持ちでした。たしかにルール無さそう。
| # Charcoal | ||
|
|
||
| > Utility-first & layered design system | ||
| > Design system library by pixiv |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: ここのフレーズは後で変える
| - ユーティリティファーストな設計 | ||
| - CSS-in-JS と CSS 両方で使える | ||
| - 既存のプロジェクトに導入がしやすい |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
キャッチフレーズ変更のタイミングでここを決めるので、今は一旦消す
| - ユーティリティファーストな設計 | |
| - CSS-in-JS と CSS 両方で使える | |
| - 既存のプロジェクトに導入がしやすい |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OKです!
pnlybubbles
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTMです!
| ## charcoal という名前 | ||
|
|
||
| ## Setup | ||
| 「charcoal(木炭)」とはデッサンの道具であり、線を引く、表現の基礎となる素材の一つです。また創作物を主役とするサービスの基盤として、それ自体は色を持たないモノクロの素材である、というニュアンスも含みます。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
めちゃよいですね。ここでコンセプトの説明がされていればリード文でコンセプトについて触れなくてもよいかもしれない。
やったこと
ドキュメントサイトにコンテンツを加えた
バージョニング
{+ 破壊的変更なし +} / {- 破壊的変更あり -}
チェックリスト
不要なチェック項目は消して構いません