Merge pull request #2604 from moreal/document-lib9c

Fix `@planetarium/lib9c` document
planetarium · Jun 3, 2024 · 2997af4 · 2997af4
2 parents cb90675 + 07b9eda
commit 2997af4
Show file tree

Hide file tree

Showing 7 changed files with 100 additions and 33 deletions.
diff --git a/@planetarium/lib9c/docs/.vitepress/config.ts b/@planetarium/lib9c/docs/.vitepress/config.ts
@@ -8,6 +8,7 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Docs', link: '/docs' },
+      { text: 'API Reference', link: 'https://jsr.io/@planetarium/lib9c' },
     ],
 
     socialLinks: [
@@ -17,23 +18,23 @@ export default defineConfig({
     i18nRouting: true,
     sidebar: [
       {
-        link: '/docs',
-        items: [
-          {
-            link: '/docs',
-            text: "Introduction"
-          },
-          {
-            link: '/docs/actions',
-            text: "Actions"
-          },
-          {
-            link: '/docs/utility',
-            text: "Utility"
-          }
-        ]
+        link: '/docs/index.md',
+        text: "Introduction"
+      },
+      {
+        link: '/docs/installation.md',
+        text: "Installation"
+      },
+      {
+        link: '/docs/actions.md',
+        text: "Actions"
+      },
+      {
+        link: '/docs/utility.md',
+        text: "Utility"
       }
     ],
+    outline: 'deep'
   },
   locales: {
     root: {
@@ -46,25 +47,25 @@ export default defineConfig({
       themeConfig: {
         i18nRouting: true,
         nav: [
-          { text: '문서', link: '/ko/docs' },
+          { text: '문서', link: '/docs.md' },
+          { text: 'API Reference', link: 'https://jsr.io/@planetarium/lib9c' },
         ],
         sidebar: [
           {
-            link: '/ko/docs',
-            items: [
-              {
-                link: '/ko/docs',
-                text: "소개"
-              },
-              {
-                link: '/ko/docs/actions',
-                text: "액션"
-              },
-              {
-                link: '/ko/docs/utility',
-                text: "유틸리티"
-              }
-            ]
+            link: '/ko/docs/index.md',
+            text: "소개"
+          },
+          {
+            link: '/ko/docs/installation.md',
+            text: "설치"
+          },
+          {
+            link: '/ko/docs/actions.md',
+            text: "액션"
+          },
+          {
+            link: '/ko/docs/utility.md',
+            text: "유틸리티"
           }
         ]
       }

diff --git a/@planetarium/lib9c/docs/docs/actions.md b/@planetarium/lib9c/docs/docs/actions.md
@@ -1,4 +1,4 @@
-# @planetarium/lib9c
+# Actions
 
 ## TransferAsset - Transfer
 

diff --git a/@planetarium/lib9c/docs/docs/installation.md b/@planetarium/lib9c/docs/docs/installation.md
@@ -0,0 +1,31 @@
+# Installation
+
+The `@planetarium/lib9c` library is distributed in a package registry called *[jsr]* and can be installed via the jsr package in npm. API documentation is also automatically generated by jsr and can be found at [package page][jsr-docs].
+
+
+[jsr]: https://jsr.io/
+[jsr-docs]: https://jsr.io/@planetarium/[email protected]+cb90675a71818491e09469b27a6ad4f19f8e3ce2/doc
+
+## Node
+
+For Node.js, depending on the package manager you are using, you can use the following.
+
+```bash
+# pnpm
+npx jsr add --pnpm @planetarium/lib9c
+
+# Yarn
+npx jsr add --yarn @planetarium/lib9c
+
+# npm
+npx jsr add @planetarium/lib9c
+```
+
+## Deno
+
+For Deno, you can install it with the Deno CLI.
+
+```bash
+# deno add @planetarium/lib9c@<version>
+deno add @planetarium/[email protected]+cb90675a71818491e09469b27a6ad4f19f8e3ce2
+```
diff --git a/@planetarium/lib9c/docs/docs/utility.md b/@planetarium/lib9c/docs/docs/utility.md
@@ -1,3 +1,5 @@
+# Utility
+
 ## Currency
 
 ### NCG

diff --git a/@planetarium/lib9c/docs/ko/docs/actions.md b/@planetarium/lib9c/docs/ko/docs/actions.md
@@ -1,4 +1,4 @@
-# @planetarium/lib9c
+# 액션
 
 ## TransferAsset - 송금
 

diff --git a/@planetarium/lib9c/docs/ko/docs/installation.md b/@planetarium/lib9c/docs/ko/docs/installation.md
@@ -0,0 +1,31 @@
+# 설치
+
+`@planetarium/lib9c` 라이브러리는 *[jsr]* 라는 패키지 레지스트리에 배포되었습니다. 그리고 npm에 있는 jsr 패키지를 통해 설치할 수 있습니다. API 문서 또한 jsr에 의해 자동 생성 되므로 [패키지 페이지][jsr-docs] 에서 확인하실 수 있습니다.
+
+
+[jsr]: https://jsr.io/
+[jsr-docs]: https://jsr.io/@planetarium/[email protected]+cb90675a71818491e09469b27a6ad4f19f8e3ce2/doc
+
+## Node
+
+Node.js의 경우 사용하고 계신 패키지 매니저에 따라 아래와 같이 사용할 수 있습니다.
+
+```bash
+# pnpm
+npx jsr add --pnpm @planetarium/lib9c
+
+# Yarn
+npx jsr add --yarn @planetarium/lib9c
+
+# npm
+npx jsr add @planetarium/lib9c
+```
+
+## Deno
+
+Deno의 경우 Deno CLI로 설치할 수 있습니다.
+
+```bash
+# deno add @planetarium/lib9c@<version>
+deno add @planetarium/[email protected]+cb90675a71818491e09469b27a6ad4f19f8e3ce2
+```
diff --git a/@planetarium/lib9c/docs/ko/docs/utility.md b/@planetarium/lib9c/docs/ko/docs/utility.md
@@ -1,3 +1,5 @@
+# 유틸리티
+
 ## 통화 (通貨)
 
 ### NCG