Initial commit

Co-authored-by: Shogo NAKAMURA <104970808+naka-12@users.noreply.github.com>
Co-authored-by: KaichiManabe <154493010+KaichiManabe@users.noreply.github.com>

Author: 3 people

.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  format:
+    name: Format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: latest
+          cache: npm
+
+      - name: Install Packages
+        run: npm ci
+        shell: bash
+
+      - name: Format
+        run: npm run format:check
+        shell: bash
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: latest
+          cache: npm
+
+      - name: Install Packages
+        run: npm ci
+        shell: bash
+
+      - name: Build
+        run: npm run build
+        shell: bash

.github/workflows/deploy.yml

@@ -0,0 +1,23 @@
+on:
+  push:
+    branches: main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - run: npm ci && npm run build
+      - uses: actions/upload-pages-artifact@v2
+        with:
+          path: build
+      - id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.nvmrc

@@ -0,0 +1 @@
+20

.prettierrc.json

@@ -0,0 +1 @@
+{}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode"]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ut.code();
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,84 @@
+# ut.code(); Starter
+
+<img alt="" src="./static/img/logo.svg" height="200px" />
+
+[![language: MDX](https://img.shields.io/badge/MDX-1B1F24.svg?logo=mdx)](https://mdxjs.com/)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+![license: MIT](https://img.shields.io/badge/license-MIT-informational.svg)
+![PRs: welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
+
+[ut.code(); Starter](https://starter.utcode.net/) は、[ut.code();](https://utcode.net/) によって作られた Web プログラミングを学ぶための入門教材です。
+さらに、高度な内容は [ut.code(); Learn](https://learn.utcode.net/) で学ぶことができます。
+
+## 目次
+
+- [開発](#開発)
+  - [要件](#要件)
+  - [環境構築](#環境構築)
+  - [開発用サーバーの起動](#開発用サーバーの起動)
+  - [ディレクトリ構成](#ディレクトリ構成)
+  - [カスタムコンポーネント](#カスタムコンポーネント)
+  - [コミットの前に](#コミットの前に)
+- [貢献](#貢献)
+
+## 開発
+
+### 要件
+
+- [Node.js](https://nodejs.org/ja/)
+- [npm](https://www.npmjs.com/)
+
+### 環境構築
+
+```shell
+npm ci
+```
+
+### 開発用サーバーの起動
+
+```shell
+npm start
+```
+
+### ディレクトリ構成
+
+`docs` フォルダ下に作られたファイルは自動でホスティングされます。
+`index.mdx` というファイルを編集することで、変更ができます。編集したい階層にある `index.mdx` ファイルを選んで編集してください。
+`index.mdx` は Markdown を拡張した MDX という非常に簡単な形式で書かれています。
+
+### カスタムコンポーネント
+
+ut.code(); Learn では、次のカスタムコンポーネントが定義されています。
+
+- Term - 用語にポップアップの説明を付ける
+- Answer - 解答例を折りたたんで隠す
+- ViewSource - GitHub と CodeSandbox で解答例を表示するボタンを表示する
+
+### コミットの前に
+
+コミットの前に、
+
+```shell
+npm run format
+```
+
+でフォーマットして、
+
+```shell
+npm run build
+```
+
+でビルドが通ることを確認してください。
+
+## ライセンス
+
+ut.code(); Learn は [MIT license](https://github.com/ut-code/utcode-starter/blob/master/LICENSE) でライセンスされています。
+Copyright © 2023 ut.code();.
+
+## 貢献
+
+Issue や Pull request などはいつでもお待ちしています。
+
+## リリースについて
+
+GitHub の Release を作成すると GitHub Pages にデプロイされます。

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
+};