メインコンテンツまでスキップ

Node.js周りの備忘録

Node.jsとは何か?

参考記事

ウェブサイト閲覧時にサイトのjavascriptを実行できるのはブラウザにjavascript実行環境があるからですが、OS上でもjavascriptを実行できるようにしたものがNode.jsだと認識しています。

DocusaurusではサイトのビルドのためにNode.jsを使用しています。

NetlifyやCloudflareなどのホストサービスではnpm buildを自動で実行してくれる機能があり、この機能を使うことでサイトの生成から公開までを自動で行うことができます。

npmとは何か?

Node.jsのパッケージ管理ツール(Pythonにおけるpipのようなもの)です。

Docusaurusもパッケージとして配布されており、本サイトのレポジトリにはDocusaurusパッケージが含まれています。

本サイトはこのパッケージを使って生成されたHTML等をウェブで閲覧できる状態にしています。

package.jsonとpackage-lock.jsonとは何か?

参考サイト

上記サイトに、package.jsonは買い出しメモ、package-lock.jsonは実際に買ってきたものの明細というわかりやすい説明がありました。

package.jsonにはver4.5以上などの条件を書き、package-lock.jsonにはver4.6など実際にインストールしたものが自動で記載されます。

npm run buildで何が実行されるか?

npm run build

を実行すると、package.jsonの記載をもとにインストールされたパッケージが実行されます。

  "scripts": {
"build": "docusaurus build",

npxを用いて直接

npx docusaurus build

と実行することも可能です。

{GitHub | GitLab}の特定ブランチを更新したタイミングでこのコマンドをCloudflareが自動で実行してくれる設定にすることで、サイトの更新を効率化することができます。

npmを使ったDocusaurusのUpdate方法

公式サイト

package.jsonの@docusaurus/hogehogeを該当バージョンに書き換えたのち、

npm install

を実行します。

次のコマンドでインストールの成功を確認できます。

npx docusaurus --version