vitepress 0.22.4 → 1.0.0-draft.3

package/dist/client/theme-default/components/SideBar.vue

@@ -1,60 +0,0 @@
-<script setup lang="ts">
-import NavLinks from './NavLinks.vue'
-import SideBarLinks from './SideBarLinks.vue'
-
-defineProps<{ open: boolean }>()
-</script>
-
-<template>
-  <aside class="sidebar" :class="{ open }">
-    <NavLinks class="nav" />
-
-    <slot name="sidebar-top" />
-
-    <SideBarLinks />
-
-    <slot name="sidebar-bottom" />
-  </aside>
-</template>
-
-<style scoped>
-.sidebar {
-  position: fixed;
-  top: var(--header-height);
-  bottom: 0;
-  left: 0;
-  z-index: var(--z-index-sidebar);
-  border-right: 1px solid var(--c-divider);
-  width: 16.4rem;
-  background-color: var(--c-bg);
-  overflow-y: auto;
-  transform: translateX(-100%);
-  transition: transform 0.25s ease;
-}
-
-@media (min-width: 720px) {
-  .sidebar {
-    transform: translateX(0);
-  }
-}
-
-@media (min-width: 960px) {
-  .sidebar {
-    width: 20rem;
-  }
-}
-
-.sidebar.open {
-  transform: translateX(0);
-}
-
-.nav {
-  display: block;
-}
-
-@media (min-width: 720px) {
-  .nav {
-    display: none;
-  }
-}
-</style>

package/dist/client/theme-default/components/SideBarLink.js

@@ -1,68 +0,0 @@
-import { h } from 'vue';
-import { useRoute, useData } from 'vitepress';
-import { joinUrl, isActive } from '../utils';
-export const SideBarLink = (props) => {
-    const route = useRoute();
-    const { site, frontmatter } = useData();
-    const depth = props.depth || 1;
-    const maxDepth = frontmatter.value.sidebarDepth || Infinity;
-    const headers = route.data.headers;
-    const text = props.item.text;
-    const link = resolveLink(site.value.base, props.item.link);
-    const children = props.item.children;
-    const active = isActive(route, props.item.link);
-    const childItems = depth < maxDepth
-        ? createChildren(active, children, headers, depth + 1)
-        : null;
-    return h('li', { class: 'sidebar-link' }, [
-        h(link ? 'a' : 'p', {
-            class: { 'sidebar-link-item': true, active },
-            href: link
-        }, text),
-        childItems
-    ]);
-};
-function resolveLink(base, path) {
-    if (path === undefined) {
-        return path;
-    }
-    // keep relative hash to the same page
-    if (path.startsWith('#')) {
-        return path;
-    }
-    return joinUrl(base, path);
-}
-function createChildren(active, children, headers, depth = 1) {
-    if (children && children.length > 0) {
-        return h('ul', { class: 'sidebar-links' }, children.map((c) => {
-            return h(SideBarLink, { item: c, depth });
-        }));
-    }
-    return active && headers
-        ? createChildren(false, resolveHeaders(headers), undefined, depth)
-        : null;
-}
-function resolveHeaders(headers) {
-    return mapHeaders(groupHeaders(headers));
-}
-function groupHeaders(headers) {
-    headers = headers.map((h) => Object.assign({}, h));
-    let lastH2;
-    headers.forEach((h) => {
-        if (h.level === 2) {
-            lastH2 = h;
-        }
-        else if (lastH2) {
-            ;
-            (lastH2.children || (lastH2.children = [])).push(h);
-        }
-    });
-    return headers.filter((h) => h.level === 2);
-}
-function mapHeaders(headers) {
-    return headers.map((header) => ({
-        text: header.title,
-        link: `#${header.slug}`,
-        children: header.children ? mapHeaders(header.children) : undefined
-    }));
-}

package/dist/client/theme-default/components/SideBarLinks.vue

@@ -1,12 +0,0 @@
-<script setup lang="ts">
-import { useSideBar } from '../composables/sideBar'
-import { SideBarLink } from './SideBarLink'
-
-const items = useSideBar()
-</script>
-
-<template>
-  <ul v-if="items.length > 0" class="sidebar-links">
-    <SideBarLink v-for="item of items" :item="item" />
-  </ul>
-</template>

package/dist/client/theme-default/components/ToggleSideBarButton.vue

@@ -1,46 +0,0 @@
-<script lang="ts">
-export default {
-  emits: ['toggle']
-}
-</script>
-
-<template>
-  <div class="sidebar-button" @click="$emit('toggle')">
-    <svg
-      class="icon"
-      xmlns="http://www.w3.org/2000/svg"
-      aria-hidden="true"
-      role="img"
-      viewBox="0 0 448 512"
-    >
-      <path
-        fill="currentColor"
-        d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"
-        class
-      />
-    </svg>
-  </div>
-</template>
-
-<style>
-.sidebar-button {
-  position: absolute;
-  top: 0.6rem;
-  left: 1rem;
-  display: none;
-  padding: 0.6rem;
-  cursor: pointer;
-}
-
-.sidebar-button .icon {
-  display: block;
-  width: 1.25rem;
-  height: 1.25rem;
-}
-
-@media screen and (max-width: 719px) {
-  .sidebar-button {
-    display: block;
-  }
-}
-</style>

package/dist/client/theme-default/components/icons/OutboundLink.vue

@@ -1,31 +0,0 @@
-<template>
-  <svg
-    class="icon outbound"
-    xmlns="http://www.w3.org/2000/svg"
-    aria-hidden="true"
-    x="0px"
-    y="0px"
-    viewBox="0 0 100 100"
-    width="15"
-    height="15"
-  >
-    <path
-      fill="currentColor"
-      d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"
-    />
-    <polygon
-      fill="currentColor"
-      points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"
-    />
-  </svg>
-</template>
-
-<style>
-.icon.outbound {
-  position: relative;
-  top: -1px;
-  display: inline-block;
-  vertical-align: middle;
-  color: var(--c-text-lighter);
-}
-</style>

package/dist/client/theme-default/composables/activeSidebarLink.js

@@ -1,99 +0,0 @@
-import { onMounted, onUnmounted, onUpdated } from 'vue';
-export function useActiveSidebarLinks() {
-    let rootActiveLink = null;
-    let activeLink = null;
-    const onScroll = throttleAndDebounce(setActiveLink, 300);
-    function setActiveLink() {
-        const sidebarLinks = getSidebarLinks();
-        const anchors = getAnchors(sidebarLinks);
-        for (let i = 0; i < anchors.length; i++) {
-            const anchor = anchors[i];
-            const nextAnchor = anchors[i + 1];
-            const [isActive, hash] = isAnchorActive(i, anchor, nextAnchor);
-            if (isActive) {
-                history.replaceState(null, document.title, hash ? hash : ' ');
-                activateLink(hash);
-                return;
-            }
-        }
-    }
-    function activateLink(hash) {
-        deactiveLink(activeLink);
-        deactiveLink(rootActiveLink);
-        activeLink = document.querySelector(`.sidebar a[href="${hash}"]`);
-        if (!activeLink) {
-            return;
-        }
-        activeLink.classList.add('active');
-        // also add active class to parent h2 anchors
-        const rootLi = activeLink.closest('.sidebar-links > ul > li');
-        if (rootLi && rootLi !== activeLink.parentElement) {
-            rootActiveLink = rootLi.querySelector('a');
-            rootActiveLink && rootActiveLink.classList.add('active');
-        }
-        else {
-            rootActiveLink = null;
-        }
-    }
-    function deactiveLink(link) {
-        link && link.classList.remove('active');
-    }
-    onMounted(() => {
-        setActiveLink();
-        window.addEventListener('scroll', onScroll);
-    });
-    onUpdated(() => {
-        // sidebar update means a route change
-        activateLink(decodeURIComponent(location.hash));
-    });
-    onUnmounted(() => {
-        window.removeEventListener('scroll', onScroll);
-    });
-}
-function getSidebarLinks() {
-    return [].slice.call(document.querySelectorAll('.sidebar a.sidebar-link-item'));
-}
-function getAnchors(sidebarLinks) {
-    return [].slice
-        .call(document.querySelectorAll('.header-anchor'))
-        .filter((anchor) => sidebarLinks.some((sidebarLink) => sidebarLink.hash === anchor.hash));
-}
-function getPageOffset() {
-    return document.querySelector('.nav-bar').offsetHeight;
-}
-function getAnchorTop(anchor) {
-    const pageOffset = getPageOffset();
-    return anchor.parentElement.offsetTop - pageOffset - 15;
-}
-function isAnchorActive(index, anchor, nextAnchor) {
-    const scrollTop = window.scrollY;
-    if (index === 0 && scrollTop === 0) {
-        return [true, null];
-    }
-    if (scrollTop < getAnchorTop(anchor)) {
-        return [false, null];
-    }
-    if (!nextAnchor || scrollTop < getAnchorTop(nextAnchor)) {
-        return [true, decodeURIComponent(anchor.hash)];
-    }
-    return [false, null];
-}
-function throttleAndDebounce(fn, delay) {
-    let timeout;
-    let called = false;
-    return () => {
-        if (timeout) {
-            clearTimeout(timeout);
-        }
-        if (!called) {
-            fn();
-            called = true;
-            setTimeout(() => {
-                called = false;
-            }, delay);
-        }
-        else {
-            timeout = setTimeout(fn, delay);
-        }
-    };
-}

package/dist/client/theme-default/composables/editLink.js

@@ -1,49 +0,0 @@
-import { computed } from 'vue';
-import { useData } from 'vitepress';
-import { endingSlashRE, isExternal } from '../utils';
-const bitbucketRE = /bitbucket.org/;
-export function useEditLink() {
-    const { page, theme, frontmatter } = useData();
-    const url = computed(() => {
-        const { repo, docsDir = '', docsBranch = 'master', docsRepo = repo, editLinks } = theme.value;
-        const showEditLink = frontmatter.value.editLink != null
-            ? frontmatter.value.editLink
-            : editLinks;
-        const { relativePath } = page.value;
-        if (!showEditLink || !relativePath || !repo) {
-            return null;
-        }
-        return createUrl(repo, docsRepo, docsDir, docsBranch, relativePath);
-    });
-    const text = computed(() => {
-        return theme.value.editLinkText || 'Edit this page';
-    });
-    return {
-        url,
-        text
-    };
-}
-function createUrl(repo, docsRepo, docsDir, docsBranch, path) {
-    return bitbucketRE.test(repo)
-        ? createBitbucketUrl(repo, docsRepo, docsDir, docsBranch, path)
-        : createGitHubUrl(repo, docsRepo, docsDir, docsBranch, path);
-}
-function createGitHubUrl(repo, docsRepo, docsDir, docsBranch, path) {
-    const base = isExternal(docsRepo)
-        ? docsRepo
-        : `https://github.com/${docsRepo}`;
-    return (base.replace(endingSlashRE, '') +
-        `/edit` +
-        `/${docsBranch}/` +
-        (docsDir ? docsDir.replace(endingSlashRE, '') + '/' : '') +
-        path);
-}
-function createBitbucketUrl(repo, docsRepo, docsDir, docsBranch, path) {
-    const base = isExternal(docsRepo) ? docsRepo : repo;
-    return (base.replace(endingSlashRE, '') +
-        `/src` +
-        `/${docsBranch}/` +
-        (docsDir ? docsDir.replace(endingSlashRE, '') + '/' : '') +
-        path +
-        `?mode=edit&spa=0&at=${docsBranch}&fileviewer=file-view-default`);
-}

package/dist/client/theme-default/composables/navLink.js

@@ -1,42 +0,0 @@
-import { computed } from 'vue';
-import { useRoute, withBase } from 'vitepress';
-import { isExternal as isExternalCheck } from '../utils';
-export function useNavLink(item) {
-    const route = useRoute();
-    const isExternal = isExternalCheck(item.value.link);
-    const props = computed(() => {
-        const routePath = normalizePath(`/${route.data.relativePath}`);
-        let active = false;
-        if (item.value.activeMatch) {
-            active = new RegExp(item.value.activeMatch).test(routePath);
-        }
-        else {
-            const itemPath = normalizePath(item.value.link);
-            active =
-                itemPath === '/'
-                    ? itemPath === routePath
-                    : routePath.startsWith(itemPath);
-        }
-        return {
-            class: {
-                active,
-                isExternal
-            },
-            href: isExternal ? item.value.link : withBase(item.value.link),
-            target: item.value.target || (isExternal ? `_blank` : null),
-            rel: item.value.rel || (isExternal ? `noopener noreferrer` : null),
-            'aria-label': item.value.ariaLabel
-        };
-    });
-    return {
-        props,
-        isExternal
-    };
-}
-function normalizePath(path) {
-    return path
-        .replace(/#.*$/, '')
-        .replace(/\?.*$/, '')
-        .replace(/\.(html|md)$/, '')
-        .replace(/\/index$/, '/');
-}

package/dist/client/theme-default/composables/nextAndPrevLinks.js

@@ -1,37 +0,0 @@
-import { computed } from 'vue';
-import { useData } from 'vitepress';
-import { isArray, ensureStartingSlash, removeExtention } from '../utils';
-import { getSideBarConfig, getFlatSideBarLinks } from '../support/sideBar';
-export function useNextAndPrevLinks() {
-    const { page, theme } = useData();
-    const path = computed(() => {
-        return removeExtention(ensureStartingSlash(page.value.relativePath));
-    });
-    const candidates = computed(() => {
-        const config = getSideBarConfig(theme.value.sidebar, path.value);
-        return isArray(config) ? getFlatSideBarLinks(config) : [];
-    });
-    const index = computed(() => {
-        return candidates.value.findIndex((item) => {
-            return item.link === path.value;
-        });
-    });
-    const next = computed(() => {
-        if (theme.value.nextLinks !== false &&
-            index.value > -1 &&
-            index.value < candidates.value.length - 1) {
-            return candidates.value[index.value + 1];
-        }
-    });
-    const prev = computed(() => {
-        if (theme.value.prevLinks !== false && index.value > 0) {
-            return candidates.value[index.value - 1];
-        }
-    });
-    const hasLinks = computed(() => !!next.value || !!prev.value);
-    return {
-        next,
-        prev,
-        hasLinks
-    };
-}

package/dist/client/theme-default/composables/repo.js

@@ -1,38 +0,0 @@
-import { computed } from 'vue';
-import { useData } from 'vitepress';
-import { EXTERNAL_URL_RE } from '../../shared';
-export const platforms = ['GitHub', 'GitLab', 'Bitbucket'].map((platform) => {
-    return [platform, new RegExp(platform, 'i')];
-});
-export function useRepo() {
-    const { site } = useData();
-    return computed(() => {
-        const theme = site.value.themeConfig;
-        const name = theme.docsRepo || theme.repo;
-        if (!name) {
-            return null;
-        }
-        const link = getRepoUrl(name);
-        const text = getRepoText(link, theme.repoLabel);
-        return { text, link };
-    });
-}
-function getRepoUrl(repo) {
-    // if the full url is not provided, default to GitHub repo
-    return EXTERNAL_URL_RE.test(repo) ? repo : `https://github.com/${repo}`;
-}
-function getRepoText(url, text) {
-    if (text) {
-        return text;
-    }
-    // if no label is provided, deduce it from the repo url
-    const hosts = url.match(/^https?:\/\/[^/]+/);
-    if (!hosts) {
-        return 'Source';
-    }
-    const platform = platforms.find(([_p, re]) => re.test(hosts[0]));
-    if (platform && platform[0]) {
-        return platform[0];
-    }
-    return 'Source';
-}

package/dist/client/theme-default/composables/sideBar.js

@@ -1,57 +0,0 @@
-import { computed } from 'vue';
-import { useRoute, useData } from 'vitepress';
-import { useActiveSidebarLinks } from '../composables/activeSidebarLink';
-import { getSideBarConfig } from '../support/sideBar';
-export function useSideBar() {
-    const route = useRoute();
-    const { site } = useData();
-    useActiveSidebarLinks();
-    return computed(() => {
-        // at first, we'll check if we can find the sidebar setting in frontmatter.
-        const headers = route.data.headers;
-        const frontSidebar = route.data.frontmatter.sidebar;
-        const sidebarDepth = route.data.frontmatter.sidebarDepth;
-        // if it's `false`, we'll just return an empty array here.
-        if (frontSidebar === false) {
-            return [];
-        }
-        // if it's `auto`, render headers of the current page
-        if (frontSidebar === 'auto') {
-            return resolveAutoSidebar(headers, sidebarDepth);
-        }
-        // now, there's no sidebar setting at frontmatter; let's see the configs
-        const themeSidebar = getSideBarConfig(site.value.themeConfig.sidebar, route.data.relativePath);
-        if (themeSidebar === false) {
-            return [];
-        }
-        if (themeSidebar === 'auto') {
-            return resolveAutoSidebar(headers, sidebarDepth);
-        }
-        return themeSidebar;
-    });
-}
-function resolveAutoSidebar(headers, depth) {
-    const ret = [];
-    if (headers === undefined) {
-        return [];
-    }
-    let lastH2 = undefined;
-    headers.forEach(({ level, title, slug }) => {
-        if (level - 1 > depth) {
-            return;
-        }
-        const item = {
-            text: title,
-            link: `#${slug}`
-        };
-        if (level === 2) {
-            lastH2 = item;
-            ret.push(item);
-        }
-        else if (lastH2) {
-            ;
-            (lastH2.children || (lastH2.children = [])).push(item);
-        }
-    });
-    return ret;
-}