vuepress-theme-uniapp-official 1.4.11

package/index.js

@@ -0,0 +1,152 @@
+function getFormattedDate() {
+  const now = new Date();
+
+  const year = now.getFullYear();
+  const month = (now.getMonth() + 1).toString().padStart(2, '0');
+  const day = now.getDate().toString().padStart(2, '0');
+  const hours = now.getHours().toString().padStart(2, '0');
+  const minutes = now.getMinutes().toString().padStart(2, '0');
+  const seconds = now.getSeconds().toString().padStart(2, '0');
+
+  const formattedDate = `${year}-${month}-${day}_${hours}-${minutes}-${seconds}`;
+
+  return formattedDate;
+}
+
+const nowString = getFormattedDate();
+const changeLoaderOptions = (options, key = 'name') => {
+	if (options && options[key]) options[key] = `${nowString}/${options[key]}`;
+	return options;
+};
+
+module.exports = (themeConfig, ctx, pluginAPI) => {
+	pluginAPI.options.chainWebpack.add('assets-chunk-timestamp', (config, isServer) => {
+		config.output.filename(`${nowString}/${config.output.get('filename')}`); //输出文件名
+		config.module.rule('images').use('url-loader').tap(changeLoaderOptions);
+		config.module.rule('fonts').use('url-loader').tap(changeLoaderOptions);
+		config.module.rule('media').use('url-loader').tap(changeLoaderOptions);
+		config.module.rule('svg').use('file-loader').tap(changeLoaderOptions);
+		if (!isServer && process.env.NODE_ENV !== 'development') {
+			const extract_css_plugin = config.plugin('extract-css');
+			const extract_css_plugin_args = extract_css_plugin.get('args');
+			if (extract_css_plugin_args) {
+				extract_css_plugin.set(
+					'args',
+					extract_css_plugin_args.map(item =>
+						changeLoaderOptions(item, 'filename')
+					)
+				);
+			}
+		}
+	})
+
+	pluginAPI.options.extendMarkdown.add('vuepress-theme-uni-app-md-plugins', (md) =>{
+		md.use(require('markdown-it-attrs'), {
+			leftDelimiter: '#{',
+			rightDelimiter: '}',
+		});
+		md.use(require('markdown-it-task-lists'));
+		md.use(require('markdown-it-raw-table'));
+	})
+
+	const klass = 'info'
+	const config = {
+		extend: '@vuepress/theme-default',
+		plugins: [
+			'@vuepress/back-to-top',
+			'mermaidjs',
+			['container', {
+				type: 'preview',
+				validate: (params) => {
+					// return params.trim().match(/^preview\s+(.*)$/);
+					return params.trim().match(/^preview/);
+				},
+
+				render: (tokens, idx, opts, event) => {
+					var m = tokens[idx].info.trim().match(/^preview\s+(.*)$/);
+					if (tokens[idx].nesting === 1) {
+						// opening tag
+						return `<CodeSimulator class="code" src="${m && m.length > 0 ? m[1] : ''}">`;
+					} else {
+						// closing tag
+						return `</CodeSimulator>`;
+					}
+				}
+			}],
+			['container',{
+				type: klass,
+				render(tokens, idx, opts, env) {
+					const token = tokens[idx]
+					const info = token.info.trim().slice(klass.length).trim()
+					if (token.nesting === 1) {
+						return `<div class="custom-block ${klass}"><p class="custom-block-title">${info || 'INFO'}</p>\n`
+					} else return `</div>\n`
+				}
+			}],
+			['zooming', {
+				selector: '.theme-default-content img.zooming',
+				options: {
+					scaleBase: 0.9,
+					bgColor: 'rgba(0,0,0,0.6)'
+				}
+			}],
+			['named-chunks',{
+				layoutChunkName: (layout) => 'layout-' + layout.componentName,
+				pageChunkName: page => {
+					const _context = page._context
+					const pageHeaders = (page.headers || []).map(item => item.title).join(',')
+					if (pageHeaders) {
+						const originDescription = page.frontmatter.description || ''
+						page.frontmatter = {
+							...page.frontmatter,
+							description: `${_context.siteConfig.description ? `${_context.siteConfig.description},` : ''}${pageHeaders}${originDescription ? `,${originDescription}` : ''}`.slice(0, 150),
+						}
+					}
+					const pagePath = page.path.indexOf('.html') === -1 ? page.path + 'index' : page.path
+					const curPath = 'docs/' + pagePath.replace('docs/', '').substring(1).replace(/\.html/g, "")
+					return curPath
+				}
+			}],
+			['check-md2',{
+				filter({errMsg, fileUrl, fullText, matchUrl, col, line}){
+					/**
+					 * errMsg："Should use .md instead of .html"、"File is not found"、"Hash should slugify"、"Hash is not found"
+					 */
+					const hashNotFound = errMsg === 'Hash is not found' && matchUrl.startsWith('#')
+					const replaceHtmlExtToMd = errMsg === "Should use .md instead of .html"
+					const fileNotFound = errMsg === "File is not found"
+					const hashShouldSlugify = errMsg === "Hash should slugify"
+					return hashNotFound || replaceHtmlExtToMd || fileNotFound || hashShouldSlugify
+				}
+			}],
+			'expandable-row'
+		]
+	}
+
+	if (Array.isArray(themeConfig.plugins) && themeConfig.plugins.length) {
+		const vuepressPluginPrefix = 'vuepress-plugin-'
+		const configPluginNames = config.plugins.map(item => typeof item === 'string' ? item : item[0])
+
+		themeConfig.plugins.forEach(item => {
+			const pluginName = typeof item === 'string' ? item : item[0]
+			let configPluginIndex = configPluginNames.indexOf(pluginName)
+			if (configPluginIndex === -1 && pluginName.indexOf(vuepressPluginPrefix) === 0) {
+				// vuepress-plugin-${pluginName} -> ${pluginName}
+				configPluginIndex = configPluginNames.indexOf(pluginName.replace(vuepressPluginPrefix, ''))
+			} else if (configPluginIndex === -1) {
+				// ${pluginName} -> vuepress-plugin-${pluginName}
+				configPluginIndex = configPluginNames.indexOf(vuepressPluginPrefix + pluginName)
+			}
+			if (configPluginIndex !== -1 && Array.isArray(item)) {
+				const configPlugin = config.plugins[configPluginIndex]
+				if (Array.isArray(configPlugin) && typeof item[1] !== 'undefined') {
+					configPlugin[1] = Object.assign(configPlugin[1], item[1])
+				} else {
+					config.plugins[configPluginIndex] = item
+				}
+			}
+		})
+	}
+
+	return config
+}

package/layouts/404.vue

@@ -0,0 +1,22 @@
+<template>
+	<div class="theme-container">
+		<!-- <div class="theme-default-content">
+			<h1>404</h1>
+
+			<blockquote>{{ getMsg() }}</blockquote>
+
+			<RouterLink to="/">Take me home.</RouterLink>
+		</div> -->
+	</div>
+</template>
+
+<script>
+	import { isServer } from '../util';
+
+	export default {
+		created() {
+			if (isServer) return;
+			this.$router.replace('/');
+		},
+	};
+</script>

package/layouts/Layout.vue

@@ -0,0 +1,238 @@
+<template>
+  <div
+    class="theme-container"
+    :class="pageClasses"
+    @touchstart="onTouchStart"
+    @touchend="onTouchEnd"
+    @keydown.ctrl="openSearch = true"
+  >
+    <Navbar
+      v-if="shouldShowNavbar"
+      @toggle-sidebar="toggleSidebar"
+    />
+
+    <div
+      class="sidebar-mask"
+      @click="toggleSidebar(false)"
+    />
+
+    <Sidebar
+      ref="sidebar"
+      :items="sidebarItems"
+      @toggle-sidebar="toggleSidebar"
+      @hook:mounted="activeSidebarLinkVisible"
+    >
+      <template #top>
+        <slot name="sidebar-top" />
+      </template>
+      <template #bottom>
+        <slot name="sidebar-bottom" />
+        <SiderBarBottom v-if="$lang === LOCALE_ZH_HANS" />
+      </template>
+    </Sidebar>
+
+    <Home v-if="$page.frontmatter.home" />
+
+    <Page
+      v-else
+      :sidebar-items="sidebarItems"
+      :style="pageStyle"
+    >
+      <template #top>
+        <slot name="page-top" />
+        <TocTop/>
+      </template>
+      <template #bottom>
+        <slot name="page-bottom" />
+        <Footer />
+      </template>
+    </Page>
+
+    <Toc />
+  </div>
+</template>
+
+<script>
+import Home from '@theme/components/Home.vue'
+import Navbar from '@theme/components/Navbar.vue'
+import Page from '@theme/components/Page.vue'
+import Sidebar from '@theme/components/Sidebar.vue'
+import Footer from '@theme/components/Footer.vue';
+import SiderBarBottom from '../components/SiderBarBottom.vue';
+import Toc from '../components/Toc';
+import TocTop from '../components/Toc-top';
+import { resolveSidebarItems, forbidScroll } from '../util'
+import navProvider from '../mixin/navProvider';
+import toc from '../mixin/toc';
+import { LOCALE_ZH_HANS } from '@theme-config/i18n';
+
+export default {
+  name: 'Layout',
+  mixins: [ navProvider, toc ],
+  components: {
+    Home,
+    Page,
+    Sidebar,
+    Navbar,
+    Footer,
+    SiderBarBottom,
+    Toc,
+    TocTop
+  },
+  data () {
+    return {
+      isSidebarOpen: false,
+      LOCALE_ZH_HANS
+    }
+  },
+  computed: {
+    shouldShowNavbar () {
+      const { themeConfig } = this.$site
+      const { frontmatter } = this.$page
+      if (
+        frontmatter.navbar === false
+        || themeConfig.navbar === false) {
+        return false
+      }
+      return (
+        this.$title
+        || themeConfig.logo
+        || themeConfig.repo
+        || themeConfig.nav
+        || this.$themeLocaleConfig.nav
+      )
+    },
+    shouldShowSidebar () {
+      const { frontmatter } = this.$page
+      return (
+        !frontmatter.home
+        && frontmatter.sidebar !== false
+        && this.sidebarItems.length
+      )
+    },
+    sidebarItems () {
+      return resolveSidebarItems(
+        this.$page,
+        this.$page.regularPath,
+        this.$site,
+        this.$localePath
+      )
+    },
+    pageClasses () {
+      const userPageClass = this.$page.frontmatter.pageClass
+      return [
+        {
+          'no-navbar': !this.shouldShowNavbar,
+          'sidebar-open': this.isSidebarOpen,
+          'no-sidebar': !this.shouldShowSidebar
+        },
+        userPageClass
+      ]
+    },
+    pageStyle () {
+      const style = {};
+
+      !this.visible && (style.paddingRight = '0px');
+
+      return style;
+    }
+  },
+  mounted () {
+    this.$router.afterEach(() => {
+      this.isSidebarOpen = false
+    })
+    forbidScroll(this.isSidebarOpen)
+    this.renderNavLinkState()
+  },
+  methods: {
+    toggleSidebar (to) {
+      this.isSidebarOpen = typeof to === 'boolean' ? to : !this.isSidebarOpen
+      this.$emit('toggle-sidebar', this.isSidebarOpen)
+    },
+    // side swipe
+    onTouchStart (e) {
+      this.touchStart = {
+        x: e.changedTouches[0].clientX,
+        y: e.changedTouches[0].clientY
+      }
+    },
+    onTouchEnd (e) {
+      const dx = e.changedTouches[0].clientX - this.touchStart.x
+      const dy = e.changedTouches[0].clientY - this.touchStart.y
+      if (Math.abs(dx) > Math.abs(dy) && Math.abs(dx) > 40) {
+        if (dx > 0 && this.touchStart.x <= 80) {
+          this.toggleSidebar(true)
+        } else {
+          this.toggleSidebar(false)
+        }
+      }
+    },
+    renderNavLinkState() {
+      this.$nextTick(() => {
+        const navs = document.querySelectorAll('nav')
+        const navLinks = []
+        const sidebarLinks = Object.keys(this.$themeConfig.sidebar)
+        const matchSidebar = sidebarLinks.filter(i => this.$page.path.includes(i)).sort((a,b) => b.length -a.length)[0]
+        navs.forEach(nav => {
+          nav.querySelectorAll('a').forEach(navLink => {
+            if(navLink.className.indexOf('external') === -1) {
+              navLinks.push(navLink)
+            }
+          })
+        })
+
+        navLinks.forEach((navLink,index) => {
+          navLink.classList.remove('router-link-active')
+          const matchWithoutMatchSidebar = sidebarLinks
+            .filter(i => i !== matchSidebar && i !== '/')
+            .find(i => navLink.href.match(i) !== null)
+          // debugger
+          const path = (this.$route.fullPath.match(/\/([\w-]+)+\//) || [])[1]
+          if (path) {
+            if (
+              navLink.href.match(matchSidebar) !== null &&
+              (
+                typeof matchWithoutMatchSidebar === 'undefined' ||
+                matchWithoutMatchSidebar.length < matchSidebar.length
+              )
+            ) {
+              navLink.classList.add('router-link-active')
+            }
+            // if (path === href) {
+            //   navLink.classList.add('router-link-active')
+            // }
+          } else {
+            // 0 => PC
+            // navLinks.length / 2 => mobile
+            if(index === 0 || index === navLinks.length / 2) {
+              navLink.classList.add('router-link-active')
+              return
+            }
+          }
+        })
+      })
+    },
+    activeSidebarLinkVisible() {
+      this.$nextTick(() => {
+        const sidebarEL = this.$refs.sidebar.$el
+        const activeLink = sidebarEL.querySelector('.sidebar-link.active')
+        if (activeLink) {
+          const sidebarScrollTop = sidebarEL.scrollTop
+          const windowInnerHeight = window.innerHeight
+          const { height, top, bottom } = activeLink.getBoundingClientRect()
+          if ((sidebarScrollTop + 50) > activeLink.offsetTop || (bottom + height) > windowInnerHeight) {
+            activeLink.scrollIntoView({ block: "center" })
+          }
+        }
+      })
+    }
+  },
+  watch: {
+    isSidebarOpen: forbidScroll,
+    $route() {
+      this.renderNavLinkState()
+      this.activeSidebarLinkVisible()
+    }
+  }
+}
+</script>

package/layouts/SimpleLayout.vue

@@ -0,0 +1,18 @@
+<template>
+  <div class="theme-container">
+    <Content class="theme-default-content" />
+    <PageEdit />
+
+    <slot name="bottom" />
+  </div>
+</template>
+
+<script>
+import PageEdit from '@theme/components/PageEdit.vue'
+export default {
+  name: 'SimpleLayout',
+  components: {
+    PageEdit
+  }
+}
+</script>

package/mixin/navInject.js

@@ -0,0 +1,21 @@
+export default {
+  inject: ['navConfig', 'customNavBar', 'changeUserNav', 'customNavBarKeys', 'navbarLanguage', 'customNavBarLinks'],
+
+  computed: {
+    showSubNavBar() {
+      return !!this.customNavBar[this.navConfig.userNavIndex].items
+    },
+    mainNavBarText() {
+      return this.customNavBar[this.navConfig.userNavIndex].text
+    },
+    subNavBarText() {
+      const curNavBar = this.customNavBar[this.navConfig.userNavIndex]
+      // fix: /uni-app-x/api/ 获取不到 subNavBarText
+      const curLink = (this.$page.path.match(/\/([^\/]+)\/([^\/]+)?/) || [])[1]
+      const item = curNavBar.items ? curNavBar.items.filter(
+        item => item.type === 'link' && item.link.indexOf(curLink) !== -1
+      )[0] : curNavBar
+      return item ? item.text : curNavBar.items[0].text
+    }
+  }
+}

package/mixin/navProvider.js

@@ -0,0 +1,65 @@
+import { navbar, navbarLanguage, userNavIndex } from '@theme-config/navbar';
+
+export default {
+  data() {
+    return { navConfig: { userNavIndex: userNavIndex || 0, languageIndex: navbarLanguage.default } }
+  },
+
+  provide() {
+    return {
+      navConfig: this.navConfig,
+      customNavBar: this.customNavBar,
+      changeUserNav: this.changeUserNav,
+      customNavBarKeys: this.customNavBarKeys,
+      customNavBarLinks: this.customNavBarLinks,
+      navbarLanguage: navbarLanguage.items
+    }
+  },
+
+  created() {
+    this.customNavBar.forEach((item, index) => {
+      if (this.$route.path.indexOf(item.link) !== -1 && item.link !== '/') this.navConfig.userNavIndex = index
+    })
+  },
+
+  computed: {
+    customNavBar() {
+      const list = []
+      navbar.forEach(item => {
+        if (item.items && item.items.length) {
+          list.push(item)
+        }
+        item.type === 'link' && list.push(item)
+      })
+      return list
+    },
+
+    customNavBarKeys() {
+      return this.customNavBar.map(item => item.text)
+    },
+
+    customNavBarLinks() {
+      return this.customNavBar.map(item => item.link)
+    }
+  },
+
+  methods: {
+    changeUserNav(index) {
+      this.navConfig.userNavIndex = index
+      const curNavBar = this.customNavBar[index]
+      const firstItemLink = curNavBar.items ? curNavBar.items[0].link : curNavBar.link
+      if (this.$page.path !== firstItemLink) this.$router.push(firstItemLink)
+    }
+  },
+
+  watch: {
+    $route(after) {
+      let navbarIndex = -1
+      this.customNavBarLinks.forEach((link, index) => {
+        if (after.path.indexOf(link) !== -1) navbarIndex = index
+      })
+      navbarIndex === -1 && (navbarIndex = 0)
+      this.navConfig.userNavIndex !== navbarIndex && navbarIndex !== -1 && (this.navConfig.userNavIndex = navbarIndex)
+    }
+  }
+}

package/mixin/toc.js

@@ -0,0 +1,36 @@
+export default {
+  data() {
+    return {
+      paddingLeftOffset: 1,
+      pageHeaders: []
+    }
+  },
+  computed: {
+    visible() {
+      return (
+        this.$frontmatter &&
+        this.$frontmatter.toc !== false &&
+        !!(this.$page && this.$page.headers && this.$page.headers.length)
+      );
+    },
+  },
+  methods: {
+    createPaddingLeft(level) {
+      return level - this.paddingLeftOffset + 'rem';
+    },
+  },
+  watch: {
+    "$page.headers": {
+      immediate: true,
+      handler() {
+        if(this.$options.name === 'Layout') return
+        this.pageHeaders = (this.$page.headers || []).filter(item => item.level > 1)
+        if ((this.pageHeaders || []).length) {
+          this.paddingLeftOffset = this.pageHeaders
+            .map(item => item.level)
+            .sort((a, b) => a - b)[0];
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "vuepress-theme-uniapp-official",
+  "version": "1.4.11",
+  "description": "uni-app official website theme for vuepress",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/StrivingRabbit/vuepress-theme-uni-app.git"
+  },
+  "keywords": [
+    "uni-app"
+  ],
+  "author": "lxh",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/StrivingRabbit/vuepress-theme-uni-app/issues"
+  },
+  "homepage": "https://github.com/StrivingRabbit/vuepress-theme-uni-app#readme",
+  "files": [
+    "components",
+    "config",
+    "global-components",
+    "layouts",
+    "mixin",
+    "styles",
+    "util",
+    "enhanceApp.js",
+    "index.js"
+  ],
+  "scripts": {
+    "publish:patch": "npm version patch && npm publish",
+    "publish:minor": "npm version minor && npm publish",
+    "publish:major": "npm version major  && npm publish",
+    "postpublish": "cnpm sync vuepress-theme-uni-app"
+  },
+  "dependencies": {
+    "@vuepress/plugin-back-to-top": "^1.9.5",
+    "algoliasearch": "^4.13.1",
+    "clipboard": "^2.0.11",
+    "vuepress-plugin-check-md2": "^1.0.5",
+    "vuepress-plugin-expandable-row": "^1.0.5",
+    "vuepress-plugin-juejin-style-copy": "^1.0.4",
+    "vuepress-plugin-mermaidjs": "1.9.1",
+    "vuepress-plugin-named-chunks": "^1.1.4",
+    "vuepress-plugin-zooming": "^1.1.8",
+    "markdown-it-attrs": "^4.1.6",
+    "markdown-it-raw-table": "^1.0.0",
+    "markdown-it-task-lists": "^2.1.1"
+  }
+}