Docusaurus

.github/workflows/deploy.yml

@@ -0,0 +1,45 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Build docusaurus
+        run: yarn build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false

.github/workflows/filename-check.yml

@@ -6,7 +6,7 @@ jobs:
     env:
       PATH_REGEX: ^.+\/docs\/.+\/(ja|en)\/section\-[0-9]\/lesson\-[0-9]_.+\.md$
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: grep invalid filename
         run: |
           ! find ./docs/**/* -maxdepth 3 -type f | grep -Ev $PATH_REGEX

.github/workflows/metadata-check.yml

@@ -6,7 +6,7 @@ jobs:
     env:
       PATH_REGEX: ^.+\/docs\/.+\/(ja|en)\/section\-[0-9]\/lesson\-[0-9]_.+\.md$
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: check lesson count
         run: |
           for dir in docs/*/ja/

.github/workflows/test-deploy.yml

@@ -0,0 +1,26 @@
+name: Test deployment
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test-deploy:
+    name: Test deployment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Test build website
+        run: yarn build
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true

.github/workflows/textlint.yml

@@ -6,14 +6,14 @@ jobs:
     runs-on: ubuntu-latest
     env:
       LEVEL: error
-      FLAGS: docs/*/ja/**/*.md
+      FLAGS: docs/**/*.md
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 18
       - name: Restore dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: node_modules
           key: ${{ runner.os }}-node-${{ hashFiles('yarn.lock') }}

.gitignore

@@ -1,8 +1,24 @@
-node_modules
+# Dependencies
+/node_modules
+
+# Production
+/build
+
 .yarn
 !.yarn/plugins
 !.yarn/releases
 
+# Generated files
+.docusaurus
+.cache-loader
 .textlintcache
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
 
+# Misc
 .DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local

.textlintrc

@@ -29,20 +29,34 @@
     "preset-ja-technical-writing": {
       "arabic-kanji-numbers": true,
       "sentence-length": {
-        "max": 200
+        "max": 300
       },
       "max-comma": {
         "max": 6
       },
       "max-ten": {
         "max": 6,
         "strict": false,
-        "touten": ["、", ","],
-        "kuten": ["。", "."]
+        "touten": [
+          "、",
+          ","
+        ],
+        "kuten": [
+          "。",
+          "."
+        ]
       },
       "max-kanji-continuous-len": {
         "max": 6,
-        "allow": ["公開鍵暗号方式", "最大送金手数料", "分散型自律組織", "運転免許証番号", "暗号通貨取引所", "候補者追加画面", "投票者追加画面"]
+        "allow": [
+          "公開鍵暗号方式",
+          "最大送金手数料",
+          "分散型自律組織",
+          "運転免許証番号",
+          "暗号通貨取引所",
+          "候補者追加画面",
+          "投票者追加画面"
+        ]
       },
       "no-mix-dearu-desumasu": {
         "preferInHeader": "",
@@ -68,11 +82,21 @@
       "ja-no-successive-word": true,
       "ja-no-abusage": false,
       "ja-no-redundant-expression": false,
-      "ja-unnatural-alphabet": {"allow": ["x", "y", "z", "k", "n", "e", "/[A-Z]/"]},
+      "ja-unnatural-alphabet": {
+        "allow": [
+          "x",
+          "y",
+          "z",
+          "k",
+          "n",
+          "e",
+          "/[A-Z]/"
+        ]
+      },
       "no-unmatched-pair": true,
       "ja-no-mixed-period": false,
       "no-doubled-joshi": {
-        "min_interval" : 1,
+        "min_interval": 1,
         "strict": false,
         "allow": [
           "か",
@@ -92,11 +116,11 @@
           "!",
           "？",
           "！"
-      ],
-      "commaCharacters": [
+        ],
+        "commaCharacters": [
           "、",
           "，"
-      ]
+        ]
       }
     },
     "no-mixed-zenkaku-and-hankaku-alphabet": {

README.md

@@ -1,37 +1,31 @@
-## 💎 **UNCHAIN Developer Community へようこそ** 👋
+# UNCHAIN-projects
 
-![](/public/images/README/unchain-banner.png)
+The project is in fact a simple markdown filesystem that is deployed as a static website using docusaurus.
 
-## 🌍 **プロジェクトのアップデートについて**
+## Local Development
 
-[UNCHAIN](https://www.unchain.tech) のプロジェクトは全て[オープンソース](https://github.com/unchain-dev/UNCHAIN-projects/blob/main/LICENSE)で運用されています。
+```
+$ yarn start
+```
 
-プロジェクトに参加していて、「こうすればもっと分かりやすいのに!」「これは間違っている!」と思ったら、直接`pull request`を送ってくださると幸いです ✨
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
-Github から直接コードを編集して直接`pull request`を送る方法は、[こちら](https://docs.github.com/ja/repositories/working-with-files/managing-files/editing-files#editing-files-in-another-users-repository)を参照してください。
-
-どんなリクエストでも大歓迎です 🎉
-
-また、プロジェクトを自分の Github アカウントに`Fork`して、中身を編集してから`pull request`を送ることもできます。
-
-- プロジェクトを`Fork`する方法は、[こちら](https://docs.github.com/ja/get-started/quickstart/fork-a-repo)を参照してください。
-
-- `Fork`から`pull request`を作成する方法は、[こちら](https://docs.github.com/ja/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)です。
-
-## 🐝 **コードの中にバグを発見した!**
-
-プロジェクトの中にバグを発見した場合は、[こちら](https://github.com/unchain-dev/UNCHAIN-projects/issues)で`Issue`を作成していただけますと幸いです。
-
-`Issue`の作成方法に関しては、[こちら](https://docs.github.com/ja/issues/tracking-your-work-with-issues/creating-an-issue)を参照してください。
-
-## ✅ textlint について
+### ✅ textlint について
 
 文中の表記揺れや誤字を防ぐため、[textlint](https://github.com/textlint/textlint) という校正チェックツールを入れています。commit する前、PR に更新があった際に GitHub Actions にて textlint を走らせています。ルールや定義の変更がある際は、下記ファイルを変更してください。
 
 - 表記揺れの定義： `prh.yml`
   - see: https://github.com/prh/prh
 - textlint のルール定義： `.textlintrc`
 
+## Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
 # Contributors
 
 <a href="https://github.com/unchain-dev/UNCHAIN-projects/graphs/contributors">

babel.config.js

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

docs/ASTAR-SocialFi/ja/section-0/lesson-1_チェーンの特徴とアプリの概要を理解しよう.md

@@ -48,7 +48,7 @@ ASTARが用意してくれている基礎的なシステムをしようすれば
 この画面の`Connect`ボタンを押すことでウォレットを接続できるようになっています。
 
 うまく接続が完了すれば次にホーム画面へ飛ぶようにできています。
-![](/public/images/ASTAR-SocialFi/section-0/0_1_1.png)
+![](/images/ASTAR-SocialFi/section-0/0_1_1.png)
 
 [`ホーム画面`]
 
@@ -60,20 +60,20 @@ ASTARが用意してくれている基礎的なシステムをしようすれば
 
 加えて、いいねの数に従ってトークンを獲得できる機能も備えておりロゴとプロフィールアイコンの間に残高が表示されます。
 
-![](/public/images/ASTAR-SocialFi/section-0/0_1_2.png)
+![](/images/ASTAR-SocialFi/section-0/0_1_2.png)
 
 [`プロフィール画面`]
 
 自分のプロフィール、フォロワー数、フォロー数、投稿内容を見ることができます。
 
 また、プロフィールの画像と名前を変更することもできます。
-![](/public/images/ASTAR-SocialFi/section-0/0_1_3.png)
+![](/images/ASTAR-SocialFi/section-0/0_1_3.png)
 
 [`メッセージ画面`]
 
 フォローしている、またはされているユーザーとメッセージのやりとりができる画面です。
-![](/public/images/ASTAR-SocialFi/section-0/0_1_4.png)
-![](/public/images/ASTAR-SocialFi/section-0/0_1_5.png)
+![](/images/ASTAR-SocialFi/section-0/0_1_4.png)
+![](/images/ASTAR-SocialFi/section-0/0_1_5.png)
 
 以上を踏まえて実装する機能は下のようになっています。
 
@@ -121,7 +121,3 @@ UNCHAINのプロジェクトをみんなでより良いものにしていきま
 ---
 
 では早速次のレッスンに進んで、ASTAR SNS作成のための環境構築をしていきましょう 🚀
-
----
-
-Documentation created by [shø](https://github.com/neila) and [Tonny](https://github.com/honganji)（UNCHAIN discord ID: shø#0537, Tonny#5693）