docs: update docs

marpple · Mar 22, 2024 · af68c96 · af68c96
1 parent c42d5a3
commit af68c96
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 5 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -7,6 +7,8 @@ export default defineConfig({
   base: '/rune/',
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
+    logo: { light: '/img/logo.png', dark: '/img/logo_dark.png', alt: 'rune' },
+    siteTitle: false,
     sidebar: [
       {
         text: 'Introduction',
@@ -40,8 +42,11 @@ export default defineConfig({
     socialLinks: [
       { icon: 'github', link: 'https://github.com/marpple/rune' }
     ],
+    search: {
+      provider: 'local'
+    },
     footer: {
-      copyright: 'Copyright © 2024 <a href="https://www.marpplecorp.com/" target="_blank">MARPPLE CORP.</a>'
+      copyright: 'Copyright © 2024 <a href="https://www.marpplecorp.com/" target="_blank">Marpple Corporation ↗</a>'
     }
   }
 })
diff --git a/docs/guide/what-is-rune.md b/docs/guide/what-is-rune.md
@@ -42,7 +42,7 @@ class SettingController extends View<Setting[]> {
 }
 ```
 
-<img src="https://s3.marpple.co/files/u_218933/2024/3/original/a3e403fe7005e00e23b99bf3a331c5c252f392401.gif" width="100%">
+<img src="/img/setting_controller.gif" width="100%">
 
 
 Rune은 그 자체로는 리액티브 하지 않습니다. 대신 컴포넌트의 조합을 거듭하면서 리액티브 한 특성을 갖게 되며 DOM 조작 코드는 점점 추상화됩니다. 이때 각 컴포넌트는 각자에 맞는 최적화된 렌더링 로직을 갖게 됩니다. 라이브러리 레벨에서의 자동적인 리렌더와 그로 인한 사이드 이펙트가 없기 때문에 유려한 UI 개발에 필요한 복잡성을 제어하기 용이하고 고도화에 유리합니다.

diff --git a/docs/img/logo.png b/docs/img/logo.png
diff --git a/docs/img/logo_dark.png b/docs/img/logo_dark.png
diff --git a/docs/img/setting_controller.gif b/docs/img/setting_controller.gif
diff --git a/docs/index.md b/docs/index.md
@@ -6,6 +6,10 @@ hero:
   name: "Rune"
   text: "Web API based Front-end SDK"
   tagline: 빠르고 견고한 프론트엔드 개발 라이브러리
+  image:
+    light: /img/logo.png
+    dark: /img/logo_dark.png
+    alt: VitePress
   actions:
     - theme: alt
       text: What is Rune?
@@ -19,9 +23,6 @@ hero:
     - theme: alt
       text: API Reference
       link: /api/view
-    - theme: alt
-      text: GitHub
-      link: https://github.com/marpple/rune
 
 features:
   - title: Front-end SDK & Library
-Original file line number
+Diff line change
@@ Expand Up / @@ -42,7 +42,7 @@ class SettingController extends View<Setting[]> { @@
     }
     ```
-    <img src="https://s3.marpple.co/files/u_218933/2024/3/original/a3e403fe7005e00e23b99bf3a331c5c252f392401.gif" width="100%">
+    <img src="/img/setting_controller.gif" width="100%">
     Rune은 그 자체로는 리액티브 하지 않습니다. 대신 컴포넌트의 조합을 거듭하면서 리액티브 한 특성을 갖게 되며 DOM 조작 코드는 점점 추상화됩니다. 이때 각 컴포넌트는 각자에 맞는 최적화된 렌더링 로직을 갖게 됩니다. 라이브러리 레벨에서의 자동적인 리렌더와 그로 인한 사이드 이펙트가 없기 때문에 유려한 UI 개발에 필요한 복잡성을 제어하기 용이하고 고도화에 유리합니다.
@@ Expand Down @@