Skip to content

Commit ad0dc24

Browse files
authored
Update README.md (#623)
* Update README.md * レビュー反映 * コンポネント -> コンポーネント * コンポネント -> コンポーネント * レビュー反映 * いらなかったです。
1 parent 463f9e7 commit ad0dc24

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

README.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
<img alt="ロゴ" src="./static/img/logo.svg" height="200px" />
44

5-
[![MDX](https://img.shields.io/badge/MDX-1B1F24.svg?logo=mdx)](https://mdxjs.com/)
5+
[![language: MDX](https://img.shields.io/badge/MDX-1B1F24.svg?logo=mdx)](https://mdxjs.com/)
66
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
7-
![license](https://img.shields.io/badge/license-MIT-informational.svg)
8-
![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
7+
![license: MIT](https://img.shields.io/badge/license-MIT-informational.svg)
8+
![PRs: welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
99

1010
[English README is here.](./README-en.md)
1111

@@ -20,7 +20,8 @@ ut.code(); Learn は、ut.code(); によって作られた Web 技術の学習
2020
- [環境構築](#環境構築)
2121
- [開発用サーバーの起動](#開発用サーバーの起動)
2222
- [ディレクトリ構成](#ディレクトリ構成)
23-
- [コードスタイル](#コードスタイル)
23+
- [カスタムコンポーネント](#カスタムコンポーネント)
24+
- [コミットの前に](#コミットの前に)
2425
- [貢献](#貢献)
2526

2627
## 概要
@@ -58,14 +59,33 @@ npm start
5859
### ディレクトリ構成
5960

6061
`docs` フォルダ下に作られたファイルは自動でホスティングされます。
61-
`index.md` というファイルを編集することで、変更ができます。編集したい階層にある `index.md` ファイルを選んで編集してください。
62-
`index.md` は Markdown を拡張した MDX という非常に簡単な形式で書かれています。
62+
`index.mdx` というファイルを編集することで、変更ができます。編集したい階層にある `index.mdx` ファイルを選んで編集してください。
63+
`index.mdx` は Markdown を拡張した MDX という非常に簡単な形式で書かれています。
6364

64-
### コードスタイル
65+
### カスタムコンポーネント
6566

66-
ut.code(); Learn は、Prettier でフォーマットされています
67+
ut.code(); Learn では、次のカスタムコンポーネントが定義されています
6768

68-
VSCode 拡張機能で Prettier をインストールして、コマンドパレットから `Format Document` を選択すると自動でフォーマットすることができます。
69+
- Term - 用語にポップアップの説明を付ける
70+
- Answer - 解答例を折りたたんで隠す
71+
- ViewSource - GitHub と CodeSandbox で解答例を表示するボタンを表示する
72+
- ExternalVideoPlayer - 動画プレイヤーを表示する
73+
74+
### コミットの前に
75+
76+
コミットの前に、
77+
78+
```shell
79+
npm run format
80+
```
81+
82+
でフォーマットして、
83+
84+
```shell
85+
npm run build
86+
```
87+
88+
でビルドが通ることを確認してください。
6989

7090
## ライセンス
7191

0 commit comments

Comments
 (0)