doc:Initialize

2024-04-21 12:32:14 +00:00 · 2018-09-16 23:38:17 +08:00
parent 2044beb7f1
commit baa5869fe5
13 changed files with 141 additions and 6 deletions
@@ -3,4 +3,5 @@ src/public
 src/routes/chart/ECharts/theme
 src/routes/chart/highCharts/mapdata
 src/locales/_build/
-src/locales/**/*.js
+src/locales/**/*.js
+docs/**/*.js
@@ -0,0 +1,8 @@
+- Getting started
+  - [Quick Start](quickstart.md)
+- Customization
+  - [Configuration](configuration.md)
+- Guide
+  - [Deploy](deploy.md)
+- Changelog
+  - 5.0.0
@@ -1,5 +1,6 @@
 <!DOCTYPE html>
 <html lang="en">
+
 <head>
  <meta charset="UTF-8">
  <title>antd-admin - An admin dashboard application demo built upon Ant Design and UmiJS</title>
@@ -8,14 +9,44 @@
  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
 </head>
+
 <body>
-  <div id="app"></div>
+  <nav data-cloak class="app-nav">
+    <a href="/">En</a>
+    <a href="#/zh-cn/">中文</a>
+  </nav>
+  <div id="app">Loading...</div>
  <script>
    window.$docsify = {
-      name: 'antd-admin',
-      repo: ''
+      name: 'AntD Admin',
+      loadSidebar: true,
+      maxLevel: 3,
+      subMaxLevel: 2,
+      auto2top: true,
+      autoHeader: true,
+      repo: 'zuiidea/antd-admin',
+      search: {
+        paths: 'auto',
+        placeholder: {
+          '/zh-cn/': '搜索',
+          '/': 'Type to search'
+        },
+
+        noData: {
+          '/zh-cn/': '找不到结果',
+          '/': 'No Results'
+        },
+      },
    }
+
+    // if (typeof navigator.serviceWorker !== 'undefined') {
+    //   navigator.serviceWorker.register('sw.js')
+    // }
  </script>
  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+  <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+  <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
+  <script src="//unpkg.com/docsify/lib/plugins/zoom-image.min.js"></script>
 </body>
-</html>
+
+</html>
@@ -0,0 +1 @@
+# getting-started
@@ -0,0 +1,83 @@
+/* ===========================================================
+ * docsify sw.js
+ * ===========================================================
+ * Copyright 2016 @huxpro
+ * Licensed under Apache 2.0
+ * Register service worker.
+ * ========================================================== */
+
+const RUNTIME = 'docsify'
+const HOSTNAME_WHITELIST = [
+  self.location.hostname,
+  'fonts.gstatic.com',
+  'fonts.googleapis.com',
+  'unpkg.com'
+]
+
+// The Util Function to hack URLs of intercepted requests
+const getFixedUrl = (req) => {
+  var now = Date.now()
+  var url = new URL(req.url)
+
+  // 1. fixed http URL
+  // Just keep syncing with location.protocol
+  // fetch(httpURL) belongs to active mixed content.
+  // And fetch(httpRequest) is not supported yet.
+  url.protocol = self.location.protocol
+
+  // 2. add query for caching-busting.
+  // Github Pages served with Cache-Control: max-age=600
+  // max-age on mutable content is error-prone, with SW life of bugs can even extend.
+  // Until cache mode of Fetch API landed, we have to workaround cache-busting with query string.
+  // Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190
+  if (url.hostname === self.location.hostname) {
+    url.search += (url.search ? '&' : '?') + 'cache-bust=' + now
+  }
+  return url.href
+}
+
+/**
+ *  @Lifecycle Activate
+ *  New one activated when old isnt being used.
+ *
+ *  waitUntil(): activating ====> activated
+ */
+self.addEventListener('activate', event => {
+  event.waitUntil(self.clients.claim())
+})
+
+/**
+ *  @Functional Fetch
+ *  All network requests are being intercepted here.
+ *
+ *  void respondWith(Promise<Response> r)
+ */
+self.addEventListener('fetch', event => {
+  // Skip some of cross-origin requests, like those for Google Analytics.
+  if (HOSTNAME_WHITELIST.indexOf(new URL(event.request.url).hostname) > -1) {
+    // Stale-while-revalidate
+    // similar to HTTP's stale-while-revalidate: https://www.mnot.net/blog/2007/12/12/stale
+    // Upgrade from Jake's to Surma's: https://gist.github.com/surma/eb441223daaedf880801ad80006389f1
+    const cached = caches.match(event.request)
+    const fixedUrl = getFixedUrl(event.request)
+    const fetched = fetch(fixedUrl, { cache: 'no-store' })
+    const fetchedCopy = fetched.then(resp => resp.clone())
+
+    // Call respondWith() with whatever we get first.
+    // If the fetch fails (e.g disconnected), wait for the cache.
+    // If there’s nothing in cache, wait for the fetch.
+    // If neither yields a response, return offline pages.
+    event.respondWith(
+      Promise.race([fetched.catch(_ => cached), cached])
+        .then(resp => resp || fetched)
+        .catch(_ => { /* eat any errors */ })
+    )
+
+    // Update the cache with the version we fetched (only for ok status)
+    event.waitUntil(
+      Promise.all([fetchedCopy, caches.open(RUNTIME)])
+        .then(([response, cache]) => response.ok && cache.put(event.request, response))
+        .catch(_ => { /* eat any errors */ })
+    )
+  }
+})
@@ -0,0 +1 @@
+# Antd Admin
@@ -0,0 +1,8 @@
+- 入门
+  - [快速开始](quickstart.md)
+- 定制化
+  - [配置项](configuration.md)
+- 指南
+  - [部署](deploy.md)
+- 更新日志
+  - 5.0.0
@@ -0,0 +1 @@
+# getting-started
@@ -100,6 +100,7 @@
    "prettier": "prettier --write 'src/**/*'",
    "precommit": "lint-staged",
    "add-locale": "lingui add-locale",
-    "extract": "lingui extract"
+    "extract": "lingui extract",
+    "doc": "docsify serve docs"
  }
 }