feat: add logo option

egoist · Jun 8, 2019 · 45662d4 · 45662d4
1 parent df36126
commit 45662d4
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 1 deletion.
diff --git a/src/components/Header.vue b/src/components/Header.vue
@@ -5,7 +5,7 @@
         <div class="header-left">
           <h1 class="site-title">
             <SidebarToggle />
-            <router-link to="/">{{ $store.getters.config.title }}</router-link>
+            <router-link to="/"> <component :is="Logo" /> </router-link>
           </h1>
           <HeaderNav v-if="leftNav" :nav="leftNav" />
         </div>
@@ -48,6 +48,24 @@ export default {
           return item.position === 'right' || !item.position
         })
       )
+    },
+
+    Logo() {
+      const {title, logo} = this.$store.getters.config
+
+      if (typeof logo === 'string') {
+        return {template: logo}
+      }
+
+      if (typeof logo === 'object') {
+        return logo
+      }
+
+      return {
+        render(h) {
+          return h('span', null, [title])
+        }
+      }
     }
   }
 }

diff --git a/website/docs/options.md b/website/docs/options.md
@@ -20,6 +20,16 @@ The ID of the target element to locate, e.g. `app` or `#app`.
 
 Website title.
 
+## logo
+
+- Type: `string` `object`
+- Default: `<span>{{ $store.getters.config.title }}</span>`
+
+Customize the logo in header.
+
+- `string`: Used as Vue template.
+- `object`: Used as Vue component.
+
 ## nav
 
 - Type: `Array<NavItem>`

diff --git a/website/docs/zh/options.md b/website/docs/zh/options.md
@@ -21,6 +21,16 @@ new Docute(options)
 
 网站标题。
 
+## logo
+
+- Type: `string` `object`
+- Default: `<span>{{ $store.getters.config.title }}</span>`
+
+Customize the logo in header.
+
+- `string`: Used as Vue template.
+- `object`: Used as Vue component.
+
 ## nav
 
 - 类型: `Array<NavItem>`