Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions docs/03extras/04website/02docusaurus/01markdown/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import LifeGame from "@site/src/components/LifeGame/LifeGame";
export const defaultMathValue = `\
$a^2 + b^2 = c^2$
$$
x = \frac{-b\pm \sqrt{b^2 - 4ac}}{2a}
x = \\frac{-b\pm \\sqrt{b^2 - 4ac}}{2a}
$$\
`;

Expand All @@ -18,7 +18,6 @@ $$\
Markdown は、文書の書き方です。

非常に簡単な文法なので、Markdown を知らない人でもだいたいの意味が理解できます。

最近では、多くのドキュメントが HTML ではなく、Markdown で書かれるようになってきています。

例えば、箇条書きは次のように入力するだけです。非常に簡単ですね。
Expand All @@ -29,22 +28,20 @@ Markdown は、文書の書き方です。
- アイテム 3
```

- アイテム 1
- アイテム 2
- アイテム 3

## はじめての Markdown

Markdown で文章を書いてみましょう。

`index.md` というファイルを作成して VSCode で開いてください。その中に次のコードを書いてみてください。`Ctrl` と `K` を同時に押してから、`V` を押すと、右側にプレビューが表示されます。

```markdown
Hello **World**
**Hello** World!
```

## Markdown の記法

ここでは、Markdown の記法をいくつか紹介します。

1. `#` と書くことで見出しを書くことができます。

<InteractiveCodeEditor language="markdown">
Expand Down Expand Up @@ -120,7 +117,7 @@ Hello **World**
</InteractiveCodeEditor>

:::info
実は、Docusaurus Markdown だけでなく MDX でも書くことができます。MDX は、Markdown の中で JSX 記法 を使えるものです。JSX 記法 は、JavaScript の中に HTML を書くことができるものですが、JavaScript や HTML の知識が必要になるので、詳しいことは自分で調べてみてください。
Markdown を拡張した MDX というものもあります。実は、Docusaurus で使うことができるのは Markdown ではなく MDX です。MDX は、Markdown の中で JSX 記法 を使えるものです。JSX 記法 は、JavaScript の中に HTML を書くことができるものですが、詳しいことは自分で調べてみてください。ここでは、簡単に例を紹介します

JavaScript を文書の中に書くことができるので、例えば次のような表現が可能です。

Expand Down
58 changes: 29 additions & 29 deletions docs/03extras/04website/02docusaurus/03docusaurus/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 3
import installDocusaurus from "./install_docusaurus.mp4";
import editDocusaurus from "./edit_docusaurus.mp4";

# Docusaurus のプロジェクトの作成方法
# Docusaurus

## Docusaurus のプロジェクトの作成方法

Expand Down Expand Up @@ -52,43 +52,43 @@ import editDocusaurus from "./edit_docusaurus.mp4";
<video src={editDocusaurus} controls width="100%" />

:::tip
Docusaurus で数式を表示するには、以下のようにします。(2022 年 12 月時点)[Docusaurus の公式サイトの説明](https://docusaurus.io/docs/markdown-features/math-equations)を参考にしてください。
Docusaurus で数式を表示できるようにするには、以下のようにします。(2022 年 12 月時点)[Docusaurus の公式サイトの説明](https://docusaurus.io/docs/markdown-features/math-equations)を参考にしてください。

1. ターミナルで以下を実行して、プラグインをインストールします。
1. ターミナルで以下を実行して、プラグインをインストールします。

```shell
npm install --save remark-math@3 rehype-katex@5 hast-util-is-element@1.1.0
```
```shell
npm install --save remark-math@3 rehype-katex@5 hast-util-is-element@1.1.0
```

1. `docusaurus.config.js` の先頭に以下を追記します。これで、数式のプラグインがインポートできます。
1. `docusaurus.config.js` の先頭に以下を追記します。これで、数式のプラグインがインポートできます。

```javascript title="docusaurus.config.js"
const math = require("remark-math");
const katex = require("rehype-katex");
```
```javascript title="docusaurus.config.js"
const math = require("remark-math");
const katex = require("rehype-katex");
```

1. `presets` オプションに以下を追記します。`docs` の中などに書くと良いでしょう。これで、`docs` の中でプラグインを使えます。
1. `presets` オプションに以下を追記します。`docs` の中などに書くと良いでしょう。これで、`docs` の中でプラグインを使えます。

```javascript title="docusaurus.config.js"
remarkPlugins: [math],
rehypePlugins: [katex],
```
```javascript title="docusaurus.config.js"
remarkPlugins: [math],
rehypePlugins: [katex],
```

1. 以下のようにスタイルシートの設定を追記します。
1. 以下のようにスタイルシートの設定を追記します。

```javascript title="docusaurus.config.js"
stylesheets: [
{
href: 'https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css',
type: 'text/css',
integrity:
'sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM',
crossorigin: 'anonymous',
},
],
```
```javascript title="docusaurus.config.js"
stylesheets: [
{
href: 'https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css',
type: 'text/css',
integrity:
'sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM',
crossorigin: 'anonymous',
},
],
```

以上のようにすると、次のようになります。よく分からなければ、以下を自分の `docusaurus.config.js` に貼り付けると良いでしょう。
以上の設定をすると、次のようになります。よく分からなければ、以下を自分の `docusaurus.config.js` に貼り付けると良いでしょう。

```javascript title="docusaurus.config.js"
// @ts-check
Expand Down
32 changes: 15 additions & 17 deletions docs/03extras/04website/02docusaurus/04GitHub/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@ import pushToGithub from "./push_to_github.mp4";

GitHub はソースコードのホスティングサービスです。Git というバージョン管理ソフトウェアを用いて、ソースコードの管理や共有が簡単にできます。

下の動画を参考にまずはアカウントを作成しましょう
下の動画を参考にまずは[https://github.com/](https://github.com/)からアカウントを作成しましょう

<video src={sighupGitHub} controls width="100%" />

## 初期設定

まずは Git の初期設定をしましょう。

<video src={setupGit} controls width="100%" />

- GitHub で `Settings`、`Emails`の順にクリックして、`Keep my email addresses private` の下に書いてあるダミーのメールアドレス(動画では、`118946511+sample-hovwec@users.noreply.github.com`)をコピーしてください。

- 次のコマンドを順に実行してください。それぞれユーザー名の設定、メールアドレスの設定、デフォルトブランチの設定(これをやっておくと、後で混乱がなくなります。)になってます。
Expand All @@ -37,10 +39,10 @@ GitHub はソースコードのホスティングサービスです。Git とい
git config --global init.defaultBranch main
```

<video src={setupGit} controls width="100%" />

次に、GitHub に自分のパソコンの公開鍵を登録して、認証しましょう。

<video src={setupSshGithub} controls width="100%" />

- 次のコマンドを実行して公開鍵を作りましょう。

```shell
Expand All @@ -51,27 +53,25 @@ GitHub はソースコードのホスティングサービスです。Git とい
ssh-keygen -t ed25519
```

- 次のコマンドを実行して公開鍵を表示しましょう。

```shell
cd ~/.ssh
```
- 次のコマンドで公開鍵を表示しましょう。

```shell
cat id_ed25519.pub
cat ~/.ssh/id_ed25519.pub
```

- 公開鍵をコピーしましょう。(動画では、`ssh-ed25519 AAAA...bGpT`)
- 表示された公開鍵をコピーしましょう。(動画では、`ssh-ed25519 AAAA...bGpT`)

- GitHub で `Settings`、`SSH and GPG keys`、`SSH keys` の中の `New SSH key` をクリックして、`Title` に適当な名前、`Key` に先程コピーした公開鍵を入力して、`Add SSH key` をクリックすると GitHub に公開鍵が登録できます。

<video src={setupSshGithub} controls width="100%" />
## GitHub へソースコードを保存

## GitHub へ保存
初期設定が終わったので、GitHub にソースコードを保存しましょう。

初期設定が終わったので、GitHub に保存しましょう。`Repositories`、`New`を押して、`Repository name` に好きな名前を入力し、`Private` を押して、`Create repository` を押してください。これで、リポジトリを作ることができます。※他の人に見られても良いのであれば、`Public` にしてください。
<video src={pushToGithub} controls width="100%" />

作成が終わったら、`SSH` をクリックして、右側にある文字をコピーしましょう。※`SSH` をクリックし忘れないように気をつけてください。
まずはリポジトリを作成します。`Repositories`、`New`を押して、`Repository name` に好きな名前を入力し、`Private` を押して、`Create repository` を押してください。これで、リポジトリを作ることができます。※全世界の人に公開するのであれば、`Public` にしてください。

リポジトリの作成が終わったら、`SSH` をクリックして、右側にある文字をコピーしましょう。※`SSH` をクリックし忘れないように気をつけてください。

次に、作成した Docusaurus のプロジェクトフォルダを VSCode で開いてそこで、次のコマンドを実行してください。これは、リポジトリをローカル上に作成する命令です。

Expand All @@ -85,7 +85,7 @@ git init
git remote add origin 先程コピーした文字
```

次に、ステージングしましょう。これは、どのファイルを Git 上で管理するか決めることができるコマンドです。`-A` はすべてを管理する命令です。`git add ファイル名` などのようにして個別に Git の管理下に含めることもできます。
次に、ステージングしましょう。これは、どのファイルを Git 上で管理するか決めることができるコマンドです。`-A` ですべてを管理します。`git add ファイル名` などのようにして個別に Git の管理下に含めることもできます。

```shell
git add -A
Expand All @@ -100,5 +100,3 @@ git commit -m "first commit"
最後に、ローカルのブランチをリモートリポジトリにプッシュしましょう。一回目だと、`Are you sure you want to continue connecting (yes/no/[fingerprint])?` と聞かれるので、`yes` と入力しましょう。これで、GitHub を開くと、ローカルのファイルが GitHub に保存されたことがわかります。

一般的な開発では、ステージングとコミットを繰り返して、時々プッシュしていくような流れになります。

<video src={pushToGithub} controls width="100%" />
12 changes: 6 additions & 6 deletions docs/03extras/04website/02docusaurus/05deploy/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import deploy from "./deploy.mp4";

# Render にデプロイ

Render は様々な Web アプリを簡単にデプロイできるプラットフォームです。実は、このシケプリは Render ではなく GitHub Pages を使っているのですが、GitHub Pages はソースコードを公開しないと使えないので、こちらを紹介しておきます
Render は様々な Web アプリを簡単にデプロイできるプラットフォームです。実は、このシケプリは Render ではなく GitHub Pages を使ってデプロイしているのですが、GitHub Pages はソースコードを公開しないと使えないので、代わりに Render を紹介しておきます

## Render の登録

Expand All @@ -17,12 +17,12 @@ Render は様々な Web アプリを簡単にデプロイできるプラット

## Render にデプロイ

初めて使うときは、次の動画のように GitHub の連携をしないといけません。
<video src={deploy} controls width="100%" />

連携ができたら、次のように入力してください
初めて使うときは、次の動画のように GitHub との連携をしないといけません

`Name` に好きな名前、`Build Command` に `npm ci && npm run build`、`Publish directory` に `build` と入力してください
連携ができたら、Docusaurus の場合は次のように入力してください

成功すると、用意された URL に作成した Web ページが表示されます。これは、世界中の人が URL を知っていればアクセスできます
`Name` に好きな名前、`Build Command` に `npm ci && npm run build`、`Publish directory` に `build` と入力してください

<video src={deploy} controls width="100%" />
成功して `Live` と表示されると、用意された URL から作成した Web ページにアクセスすることができます。この URL にアクセスすることで、世界中の人が作った Web サイトを見ることができます。
Loading