-
-```
-
-### `useRoute`
-
-Returns the current route object with the following type:
-
-```ts
-interface Route {
- path: string
- data: PageData
- component: Component | null
-}
-```
-
-### `useRouter`
-
-Returns the VitePress router instance so you can programmatically navigate to another page.
-
-```ts
-interface Router {
- route: Route
- go: (href?: string) => Promise
-}
-```
-
-### `withBase`
-
-- **Type**: `(path: string) => string`
-
- Appends the configured [`base`](../config/basics#base) to a given URL path. Also see [Base URL](./assets#base-url).
-
-## Global Components
-
-VitePress comes with few built-in component that can be used globally. You may use these components in your markdown or your custom theme configuration.
-
-### ``
-
-The `` component displays the rendered markdown contents. Useful [when creating your own theme](./theming).
-
-```vue
-
-
Custom Layout!
-
-
-```
-
-### ``
-
-The `` component renders its slot only at client side.
-
-Because VitePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the universal code requirements. In short, make sure to only access Browser / DOM APIs in beforeMount or mounted hooks.
-
-If you are using or demoing components that are not SSR-friendly (for example, contain custom directives), you can wrap them inside the `ClientOnly` component.
-
-```html
-
-
-
-```
diff --git a/docs/guide/assets.md b/docs/guide/assets.md
deleted file mode 100644
index 20969f9c..00000000
--- a/docs/guide/assets.md
+++ /dev/null
@@ -1,55 +0,0 @@
-# Asset Handling
-
-All Markdown files are compiled into Vue components and processed by [Vite](https://github.com/vitejs/vite). You can, **and should**, reference any assets using relative URLs:
-
-```md
-
-```
-
-You can reference static assets in your markdown files, your `*.vue` components in the theme, styles and plain `.css` files either using absolute public paths (based on project root) or relative paths (based on your file system). The latter is similar to the behavior you are used to if you have used `vue-cli` or webpack's `file-loader`.
-
-Common image, media, and font filetypes are detected and included as assets automatically.
-
-All referenced assets, including those using absolute paths, will be copied to the dist folder with a hashed file name in the production build. Never-referenced assets will not be copied. Similar to `vue-cli`, image assets smaller than 4kb will be base64 inlined.
-
-All **static** path references, including absolute paths, should be based on your working directory structure.
-
-## Public Files
-
-Sometimes you may need to provide static assets that are not directly referenced in any of your Markdown or theme components (for example, favicons and PWA icons). The `public` directory under project root can be used as an escape hatch to provide static assets that either are never referenced in source code (e.g. `robots.txt`), or must retain the exact same file name (without hashing).
-
-Assets placed in `public` will be copied to the root of the dist directory as-is.
-
-Note that you should reference files placed in `public` using root absolute path - for example, `public/icon.png` should always be referenced in source code as `/icon.png`.
-
-## Base URL
-
-If your site is deployed to a non-root URL, you will need to set the `base` option in `.vitepress/config.js`. For example, if you plan to deploy your site to `https://foo.github.io/bar/`, then `base` should be set to `'/bar/'` (it should always start and end with a slash).
-
-All your static asset paths are automatically processed to adjust for different `base` config values. For example, if you have an absolute reference to an asset under `public` in your markdown:
-
-```md
-
-```
-
-You do **not** need to update it when you change the `base` config value in this case.
-
-However, if you are authoring a theme component that links to assets dynamically, e.g. an image whose `src` is based on a theme config value:
-
-```vue
-
-```
-
-In this case it is recommended to wrap the path with the [`withBase` helper](./api#withbase) provided by VitePress:
-
-```vue
-
-
-
-
-
-```
diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md
deleted file mode 100644
index f2661653..00000000
--- a/docs/guide/configuration.md
+++ /dev/null
@@ -1,79 +0,0 @@
-# Configuration
-
-## Overview
-
-Without any configuration, the page is pretty minimal, and the user has no way to navigate around the site. To customize your site, let’s first create a `.vitepress` directory inside your docs directory. This is where all VitePress-specific files will be placed. Your project structure is probably like this:
-
-```bash
-.
-├─ docs
-│ ├─ .vitepress
-│ │ └─ config.js
-│ └─ index.md
-└─ package.json
-```
-
-The essential file for configuring a VitePress site is `.vitepress/config.js`, which should export a JavaScript object:
-
-```js
-export default {
- title: 'Hello VitePress',
- description: 'Just playing around.'
-}
-```
-
-Check out the [Config Reference](../config/basics) for a full list of options.
-
-## Config Intellisense
-
-Since VitePress ships with TypeScript typings, you can leverage your IDE's intellisense with jsdoc type hints:
-
-```js
-/**
- * @type {import('vitepress').UserConfig}
- */
-const config = {
- // ...
-}
-
-export default config
-```
-
-Alternatively, you can use the `defineConfig` helper at which should provide intellisense without the need for jsdoc annotations:
-
-```js
-import { defineConfig } from 'vitepress'
-
-export default defineConfig({
- // ...
-})
-```
-
-VitePress also directly supports TS config files. You can use `.vitepress/config.ts` with the `defineConfig` helper as well.
-
-## Typed Theme Config
-
-By default, `defineConfig` helper leverages the theme config type from default theme:
-
-```ts
-import { defineConfig } from 'vitepress'
-
-export default defineConfig({
- themeConfig: {
- // Type is `DefaultTheme.Config`
- }
-})
-```
-
-If you use a custom theme and want type checks for the theme config, you'll need to use `defineConfigWithTheme` instead, and pass the config type for your custom theme via a generic argument:
-
-```ts
-import { defineConfigWithTheme } from 'vitepress'
-import { ThemeConfig } from 'your-theme'
-
-export default defineConfigWithTheme({
- themeConfig: {
- // Type is `ThemeConfig`
- }
-})
-```
diff --git a/docs/guide/deploy.md b/docs/guide/deploy.md
deleted file mode 100644
index 8497ecd6..00000000
--- a/docs/guide/deploy.md
+++ /dev/null
@@ -1,267 +0,0 @@
----
-sidebarDepth: 3
----
-
-# Deploying
-
-The following guides are based on some shared assumptions:
-
-- You are placing your docs inside the `docs` directory of your project;
-- You are using the default build output location (`.vitepress/dist`);
-- VitePress is installed as a local dependency in your project, and you have setup the following npm scripts:
-
-```json
-{
- "scripts": {
- "docs:build": "vitepress build docs",
- "docs:serve": "vitepress serve docs"
- }
-}
-```
-
-## Building The Docs
-
-You may run `yarn docs:build` command to build the docs.
-
-```bash
-$ yarn docs:build
-```
-
-By default, the build output will be placed at `.vitepress/dist`. You may deploy this `dist` folder to any of your preferred platforms.
-
-### Testing The Docs Locally
-
-Once you've built the docs, you may test them locally by running `yarn docs:serve` command.
-
-```bash
-$ yarn docs:build
-$ yarn docs:serve
-```
-
-The `serve` command will boot up local static web server that serves the files from `.vitepress/dist` at `http://localhost:5000`. It's an easy way to check if the production build looks OK in your local environment.
-
-You may configure the port of the server py passing `--port` flag as an argument.
-
-```json
-{
- "scripts": {
- "docs:serve": "vitepress serve docs --port 8080"
- }
-}
-```
-
-Now the `docs:serve` method will launch the server at `http://localhost:8080`.
-
-## GitHub Pages
-
-1. Set the correct `base` in `docs/.vitepress/config.js`.
-
- If you are deploying to `https://.github.io/`, you can omit `base` as it defaults to `'/'`.
-
- If you are deploying to `https://.github.io//`, for example your repository is at `https://github.com//`, then set `base` to `'//'`.
-
-2. Inside your project, create `deploy.sh` with the following content (with highlighted lines uncommented appropriately), and run it to deploy:
-
-```bash{13,20,23}
-#!/usr/bin/env sh
-
-# abort on errors
-set -e
-
-# build
-npm run docs:build
-
-# navigate into the build output directory
-cd docs/.vitepress/dist
-
-# if you are deploying to a custom domain
-# echo 'www.example.com' > CNAME
-
-git init
-git add -A
-git commit -m 'deploy'
-
-# if you are deploying to https://.github.io
-# git push -f git@github.com:/.github.io.git main
-
-# if you are deploying to https://.github.io/
-# git push -f git@github.com:/.git main:gh-pages
-
-cd -
-```
-
-::: tip
-You can also run the above script in your CI setup to enable automatic deployment on each push.
-:::
-
-### GitHub Pages and Travis CI
-
-1. Set the correct `base` in `docs/.vitepress/config.js`.
-
- If you are deploying to `https://.github.io/`, you can omit `base` as it defaults to `'/'`.
-
- If you are deploying to `https://.github.io//`, for example your repository is at `https://github.com//`, then set `base` to `'//'`.
-
-2. Create a file named `.travis.yml` in the root of your project.
-
-3. Run `yarn` or `npm install` locally and commit the generated lockfile (that is `yarn.lock` or `package-lock.json`).
-
-4. Use the GitHub Pages deploy provider template, and follow the [Travis CI documentation](https://docs.travis-ci.com/user/deployment/pages).
-
-```yaml
-language: node_js
-node_js:
- - lts/*
-install:
- - yarn install # npm ci
-script:
- - yarn docs:build # npm run docs:build
-deploy:
- provider: pages
- skip_cleanup: true
- local_dir: docs/.vitepress/dist
- # A token generated on GitHub allowing Travis to push code on you repository.
- # Set in the Travis settings page of your repository, as a secure variable.
- github_token: $GITHUB_TOKEN
- keep_history: true
- on:
- branch: main
-```
-
-## GitLab Pages and GitLab CI
-
-1. Set the correct `base` in `docs/.vitepress/config.js`.
-
- If you are deploying to `https://.gitlab.io/`, you can omit `base` as it defaults to `'/'`.
-
- If you are deploying to `https://.gitlab.io//`, for example your repository is at `https://gitlab.com//`, then set `base` to `'//'`.
-
-2. Set `outDir` in `.vitepress/config.js` to `../public`.
-
-3. Create a file called `.gitlab-ci.yml` in the root of your project with the content below. This will build and deploy your site whenever you make changes to your content:
-
-```yaml
-image: node:16.5.0
-pages:
- stage: deploy
- cache:
- paths:
- - node_modules/
- script:
- - yarn install # npm install
- - yarn docs:build # npm run docs:build
- artifacts:
- paths:
- - public
- rules:
- - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
-```
-
-## Netlify
-
-1. On [Netlify](https://www.netlify.com/), setup up a new project from GitHub with the following settings:
-
-- **Build Command:** `vitepress build docs` or `yarn docs:build` or `npm run docs:build`
-- **Publish directory:** `docs/.vitepress/dist`
-
-2. Hit the deploy button.
-
-## Google Firebase
-
-1. Make sure you have [firebase-tools](https://www.npmjs.com/package/firebase-tools) installed.
-
-2. Create `firebase.json` and `.firebaserc` at the root of your project with the following content:
-
-`firebase.json`:
-
-```json
-{
- "hosting": {
- "public": "./docs/.vitepress/dist",
- "ignore": []
- }
-}
-```
-
-`.firebaserc`:
-
-```js
-{
- "projects": {
- "default": ""
- }
-}
-```
-
-3. After running `yarn docs:build` or `npm run docs:build`, deploy using the command `firebase deploy`.
-
-## Surge
-
-1. First install [surge](https://www.npmjs.com/package/surge), if you haven’t already.
-
-2. Run `yarn docs:build` or `npm run docs:build`.
-
-3. Deploy to surge by typing `surge docs/.vitepress/dist`.
-
-You can also deploy to a [custom domain](https://surge.sh/help/adding-a-custom-domain) by adding `surge docs/.vitepress/dist yourdomain.com`.
-
-## Heroku
-
-1. Install [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli).
-
-2. Create a Heroku account by [signing up](https://signup.heroku.com).
-
-3. Run `heroku login` and fill in your Heroku credentials:
-
-```bash
-$ heroku login
-```
-
-4. Create a file called `static.json` in the root of your project with the below content:
-
-`static.json`:
-
-```json
-{
- "root": "./docs/.vitepress/dist"
-}
-```
-
-This is the configuration of your site; read more at [heroku-buildpack-static](https://github.com/heroku/heroku-buildpack-static).
-
-5. Set up your Heroku git remote:
-
-```bash
-# version change
-$ git init
-$ git add .
-$ git commit -m "My site ready for deployment."
-
-# creates a new app with a specified name
-$ heroku apps:create example
-
-# set buildpack for static sites
-$ heroku buildpacks:set https://github.com/heroku/heroku-buildpack-static.git
-```
-
-6. Deploy your site:
-
-```bash
-# publish site
-$ git push heroku main
-
-# opens a browser to view the Dashboard version of Heroku CI
-$ heroku open
-```
-
-## Vercel
-
-To deploy your VitePress app with a [Vercel for Git](https://vercel.com/docs/concepts/git), make sure it has been pushed to a Git repository.
-
-Go to https://vercel.com/new and import the project into Vercel using your Git of choice (GitHub, GitLab or BitBucket). Follow the wizard to select the project root with the project's `package.json` and override the build step using `yarn docs:build` or `npm run docs:build` and the output dir to be `./docs/.vitepress/dist`
-
-
-
-After your project has been imported, all subsequent pushes to branches will generate Preview Deployments, and all changes made to the Production Branch (commonly "main") will result in a Production Deployment.
-
-Once deployed, you will get a URL to see your app live, such as the following: https://vitepress.vercel.app
diff --git a/docs/guide/differences-from-vuepress.md b/docs/guide/differences-from-vuepress.md
deleted file mode 100644
index b6c6eab5..00000000
--- a/docs/guide/differences-from-vuepress.md
+++ /dev/null
@@ -1,119 +0,0 @@
----
-sidebarDepth: 2
----
-
-# Differences from VuePress
-
-VitePress and VuePress have different [design goals](../index.md). Both projects share similar config naming conventions. VitePress aims to have the bare minimum features needed for authoring docs. Other features are pushed to Themes. On the other hand, VuePress has more features out-of-the-box or enabled by its ecosystem of plugins.
-
-::: tip
-If you are using VuePress, there is no need to migrate to VitePress. Both projects are going to continue to co-exist for the foreseeable future.
-:::
-
-::: warning
-Note this is early WIP! Currently, the focus is on making Vite stable and feature-complete first. It is not recommended to use this for anything serious yet.
-:::
-
-In case you decide to move your project to VitePress, this is a list of differences from [VuePress v1.7.1](https://github.com/vuejs/vuepress/releases/tag/v1.7.1) that you need to take into account.
-
-## General
-
-- Missing
- - YAML and TOML are not supported formats for site config. Only javascript is supported for `.vitepress/config.js`
- - [Plugins](https://vuepress.vuejs.org/plugin/) support, features are implemented in themes
- - [permalink support](https://vuepress.vuejs.org/guide/permalinks.html)
- - `.vitepress/templates`
- - Components in `.vitepress/components` [are not auto registered as global components](https://vuepress.vuejs.org)
-- Differences
- - [Public files](https://vuepress.vuejs.org/guide/assets.html#public-files) that are directly copied to dist root moved from `.vitepress/public/` is `public/`
- - [styling](https://vuepress.vuejs.org/config/#styling) `.vitepress/styles/index.styl` and `.vitepress/styles/palette.styl` is not supported. See [Customizing CSS](./theming#customizing-css).
- - [App Level Enhancements](https://vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements) API, app enhancements `.vitepress/enhanceApp.js` is now done in `.vitepress/theme/index.js`. See [Extending the Default Theme](./theming#extending-the-default-theme).
-
-## Markdown
-
-- Missing
- - Support for [toml in frontmatter](https://vuepress.vuejs.org/guide/frontmatter.html#alternative-frontmatter-formats)
- - [details block](https://vuepress.vuejs.org/guide/markdown.html#custom-containers)
- - [markdown slots](https://vuepress.vuejs.org/guide/markdown-slot.html)
- - `~` prefix to explicitly specify a url is a [webpack module request](https://vuepress.vuejs.org/guide/assets.html#relative-urls)
-
-## Site Config
-
-- Missing
- - `temp`
- - `dest`
- - [`theme` from a dependency](https://vuepress.vuejs.org/theme/using-a-theme.html#using-a-theme-from-a-dependency)
- - `permalink`
- - [`port`](https://vuepress.vuejs.org/config/#port)
- - [`shouldPrefetch`](https://vuepress.vuejs.org/config/#shouldprefetch)
- - [`cache`](https://vuepress.vuejs.org/config/#cache)
- - [`extraWatchFiles`](https://vuepress.vuejs.org/config/#extrawatchfiles)
- - [`patterns`](https://vuepress.vuejs.org/config/#patterns)
- - [`plugins`](https://vuepress.vuejs.org/config/#pluggable)
- - [`markdown.pageSuffix`](https://vuepress.vuejs.org/config/#markdown-pagesuffix)
- - [`markdown.slugify`](https://vuepress.vuejs.org/config/#markdown-slugify)
- - [`markdown.plugins`](https://vuepress.vuejs.org/config/#markdown-plugins)
- - [`markdown.extractHeaders`](https://vuepress.vuejs.org/config/#markdown-extractheaders)
- - `markdown.extendMarkdown` to `markdown.config`
- - `configureWebpack`, `chainWebpack`, `postcss`, `Stylus`, `scss`, `Sass`, `less` configs
- - [`evergreen`](https://vuepress.vuejs.org/config/#evergreen)
-
-## Default Theme Config
-
-- Missing
- - [`smoothScroll`](https://vuepress.vuejs.org/theme/default-theme-config.html#smooth-scrolling)
- - [`displayAllHeaders`](https://vuepress.vuejs.org/theme/default-theme-config.html#displaying-header-links-of-all-pages)
- - [`activeHeaderLinks`](https://vuepress.vuejs.org/theme/default-theme-config.html#active-header-links)
- - `sidebarDepth` and `initialOpenGroupIndex` for [sidebar groups](https://vuepress.vuejs.org/theme/default-theme-config.html#sidebar-groups)
-- Differences
- - `searchMaxSuggestions` is `search.maxSuggestions`
- - `algolia` is `search.algolia`
- - `searchPlaceholder` is `search.placeholder`
-
-## Default Theme
-
-- Missing
- - [`` and ``](https://vuepress.vuejs.org/theme/default-theme-config.html#code-groups-and-code-blocks)
-
-## Computed Globals
-
-- Missing
- - `$lang`
- - `$localePath`
-
-## Frontmatter Predefined Variables
-
-- Missing
- - `description`
- - [`meta`](https://vuepress.vuejs.org/guide/frontmatter.html#meta)
- - [`metaTitle`](https://vuepress.vuejs.org/guide/frontmatter.html#predefined-variables)
- - `lang`
- - [`layout`](https://vuepress.vuejs.org/guide/frontmatter.html#layout)
- - [`permalink`](https://vuepress.vuejs.org/guide/frontmatter.html#predefined-variables)
- - [`canonicalUrl`](https://vuepress.vuejs.org/guide/frontmatter.html#predefined-variables)
-
-## Frontmatter Default Theme Variables
-
-- Missing
- - `prev`, `next`
- - [`search`](https://vuepress.vuejs.org/guide/frontmatter.html#search)
- - [`tags`](https://vuepress.vuejs.org/guide/frontmatter.html#tags)
- - [`pageClass`](https://vuepress.vuejs.org/theme/default-theme-config.html#custom-page-class)
- - [`layout`](https://vuepress.vuejs.org/theme/default-theme-config.html#custom-layout-for-specific-pages)
-
-## siteData
-
-- Missing
- - [`pages`](https://vuepress.vuejs.org/theme/writing-a-theme.html#site-and-page-metadata)
-
-## pageData
-
-- Missing
- - `key`
- - `path`
- - `regularPath`
-
-## Global Components
-
-- Missing
- - [``](https://vuepress.vuejs.org/guide/using-vue.html#badge)
diff --git a/docs/guide/frontmatter.md b/docs/guide/frontmatter.md
deleted file mode 100644
index 40fd2691..00000000
--- a/docs/guide/frontmatter.md
+++ /dev/null
@@ -1,87 +0,0 @@
-# Frontmatter
-
-Any Markdown file that contains a YAML frontmatter block will be processed by [gray-matter](https://github.com/jonschlinkert/gray-matter). The frontmatter must be at the top of the Markdown file, and must take the form of valid YAML set between triple-dashed lines. Example:
-
-```md
----
-title: Docs with VitePress
-editLink: true
----
-```
-
-Between the triple-dashed lines, you can set [predefined variables](#predefined-variables), or even create custom ones of your own. These variables can be used via the special $frontmatter variable.
-
-Here’s an example of how you could use it in your Markdown file:
-
-```md
----
-title: Docs with VitePress
-editLink: true
----
-
-# {{ $frontmatter.title }}
-
-Guide content
-```
-
-## Alternative frontmatter Formats
-
-VitePress also supports JSON frontmatter syntax, starting and ending in curly braces:
-
-```json
----
-{
- "title": "Blogging Like a Hacker",
- "editLink": true
-}
----
-```
-
-## Predefined Variables
-
-### title
-
-- Type: `string`
-- Default: `h1_title || siteData.title`
-
-Title of the current page.
-
-### head
-
-- Type: `array`
-- Default: `undefined`
-
-Specify extra head tags to be injected:
-
-```yaml
----
-head:
- - - meta
- - name: description
- content: hello
- - - meta
- - name: keywords
- content: super duper SEO
----
-```
-
-### navbar
-
-- Type: `boolean`
-- Default: `undefined`
-
-You can disable the navbar on a specific page with `navbar: false`
-
-### sidebar
-
-- Type: `boolean|'auto'`
-- Default: `undefined`
-
-You can decide to show the sidebar on a specific page with `sidebar: auto` or disable it with `sidebar: false`
-
-### editLink
-
-- Type: `boolean`
-- Default: `undefined`
-
-Define if this page should include an edit link.
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
deleted file mode 100644
index 2b891fd3..00000000
--- a/docs/guide/getting-started.md
+++ /dev/null
@@ -1,51 +0,0 @@
-# Getting Started
-
-This section will help you build a basic VitePress documentation site from ground up. If you already have an existing project and would like to keep documentation inside the project, start from Step 3.
-
-- **Step. 1:** Create and change into a new directory.
-
- ```bash
- $ mkdir vitepress-starter && cd vitepress-starter
- ```
-
-- **Step. 2:** Initialize with your preferred package manager.
-
- ```bash
- $ yarn init
- ```
-
-- **Step. 3:** Install VitePress locally.
-
- ```bash
- $ yarn add --dev vitepress
- ```
-
-- **Step. 4:** Create your first document.
-
- ```bash
- $ mkdir docs && echo '# Hello VitePress' > docs/index.md
- ```
-
-- **Step. 5:** Add some scripts to `package.json`.
-
- ```json
- {
- "scripts": {
- "docs:dev": "vitepress dev docs",
- "docs:build": "vitepress build docs",
- "docs:serve": "vitepress serve docs"
- }
- }
- ```
-
-- **Step. 6:** Serve the documentation site in the local server.
-
- ```bash
- $ yarn docs:dev
- ```
-
- VitePress will start a hot-reloading development server at `http://localhost:3000`.
-
-By now, you should have a basic but functional VitePress documentation site.
-
-When your documentation site starts to take shape, be sure to read the [deployment guide](./deploy).
diff --git a/docs/guide/global-component.md b/docs/guide/global-component.md
deleted file mode 100644
index ce843322..00000000
--- a/docs/guide/global-component.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# Global Component
-
-VitePress comes with few built-in component that can be used globally. You may use these components in your markdown or your custom theme configuration.
-
-## Content
-
-The `Content` component displays the rendered markdown contents. Useful [when creating your own theme](./theming).
-
-```vue
-
-
Custom Layout!
-
-
-```
-
-## ClientOnly
-
-The `ClientOnly` component renderes its slot only at client side.
-
-Because VitePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the universal code requirements. In short, make sure to only access Browser / DOM APIs in beforeMount or mounted hooks.
-
-If you are using or demoing components that are not SSR-friendly (for example, contain custom directives), you can wrap them inside the `ClientOnly` component.
-
-```html
-
-
-
-```
-
-## OutboundLink
-
-The indicator `OutboundLink` is used to denote external links. In VitePress, this component has been followed by every external link.
diff --git a/docs/guide/markdown.md b/docs/guide/markdown.md
deleted file mode 100644
index 693e915c..00000000
--- a/docs/guide/markdown.md
+++ /dev/null
@@ -1,449 +0,0 @@
----
-sidebarDepth: 3
----
-
-# Markdown Extensions
-
-## Header Anchors
-
-Headers automatically get anchor links applied. Rendering of anchors can be configured using the `markdown.anchor` option.
-
-## Links
-
-### Internal Links
-
-Internal links are converted to router link for SPA navigation. Also, every `index.md` contained in each sub-directory will automatically be converted to `index.html`, with corresponding URL `/`.
-
-For example, given the following directory structure:
-
-```
-.
-├─ index.md
-├─ foo
-│ ├─ index.md
-│ ├─ one.md
-│ └─ two.md
-└─ bar
- ├─ index.md
- ├─ three.md
- └─ four.md
-```
-
-And providing you are in `foo/one.md`:
-
-```md
-[Home](/)
-[foo](/foo/)
-[foo heading](./#heading)
-[bar - three](../bar/three)
-[bar - three](../bar/three.md)
-[bar - four](../bar/four.html)
-```
-
-### Page Suffix
-
-Pages and internal links get generated with the `.html` suffix by default.
-
-### External Links
-
-Outbound links automatically get `target="_blank" rel="noopener noreferrer"`:
-
-- [vuejs.org](https://vuejs.org)
-- [VitePress on GitHub](https://github.com/vuejs/vitepress)
-
-## Frontmatter
-
-[YAML frontmatter](https://jekyllrb.com/docs/front-matter/) is supported out of the box:
-
-```yaml
----
-title: Blogging Like a Hacker
-lang: en-US
----
-```
-
-This data will be available to the rest of the page, along with all custom and theming components.
-
-For more details, see [Frontmatter](./frontmatter).
-
-## GitHub-Style Tables
-
-**Input**
-
-```
-| Tables | Are | Cool |
-| ------------- |:-------------:| -----:|
-| col 3 is | right-aligned | $1600 |
-| col 2 is | centered | $12 |
-| zebra stripes | are neat | $1 |
-```
-
-**Output**
-
-| Tables | Are | Cool |
-| ------------- | :-----------: | -----: |
-| col 3 is | right-aligned | \$1600 |
-| col 2 is | centered | \$12 |
-| zebra stripes | are neat | \$1 |
-
-## Emoji :tada:
-
-**Input**
-
-```
-:tada: :100:
-```
-
-**Output**
-
-:tada: :100:
-
-A [list of all emojis](https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/data/full.json) is available.
-
-## Table of Contents
-
-**Input**
-
-```
-[[toc]]
-```
-
-**Output**
-
-[[toc]]
-
-Rendering of the TOC can be configured using the `markdown.toc` option.
-
-## Custom Containers
-
-Custom containers can be defined by their types, titles, and contents.
-
-### Default Title
-
-**Input**
-
-```md
-::: tip
-This is a tip
-:::
-
-::: info
-This is an info box
-:::
-
-::: warning
-This is a warning
-:::
-
-::: danger
-This is a dangerous warning
-:::
-
-::: details
-This is a details block, which does not work in Internet Explorer or old versions of Edge.
-:::
-```
-
-**Output**
-
-::: tip
-This is a tip
-:::
-
-::: info
-This is an info box
-:::
-
-::: warning
-This is a warning
-:::
-
-::: danger
-This is a dangerous warning
-:::
-
-::: details
-This is a details block, which does not work in Internet Explorer or Edge.
-:::
-
-### Custom Title
-
-**Input**
-
-````md
-::: danger STOP
-Danger zone, do not proceed
-:::
-
-::: details Click me to view the code
-
-```js
-console.log('Hello, VitePress!')
-```
-
-:::
-````
-
-**Output**
-
-::: danger STOP
-Danger zone, do not proceed
-:::
-
-::: details Click me to view the code
-
-```js
-console.log('Hello, VitePress!')
-```
-
-:::
-
-## Syntax Highlighting in Code Blocks
-
-VitePress uses [Prism](https://prismjs.com) to highlight language syntax in Markdown code blocks, using coloured text. Prism supports a wide variety of programming languages. All you need to do is append a valid language alias to the beginning backticks for the code block:
-
-**Input**
-
-````
-```js
-export default {
- name: 'MyComponent',
- // ...
-}
-```
-````
-
-**Output**
-
-```js
-export default {
- name: 'MyComponent'
- // ...
-}
-```
-
-**Input**
-
-````
-```html
-
-
- {{ todo.text }}
-
-
-```
-````
-
-**Output**
-
-```html
-
-
{{ todo.text }}
-
-```
-
-A [list of valid languages](https://prismjs.com/#languages-list) is available on Prism’s site.
-
-## Line Highlighting in Code Blocks
-
-**Input**
-
-````
-```js{4}
-export default {
- data () {
- return {
- msg: 'Highlighted!'
- }
- }
-}
-```
-````
-
-**Output**
-
-```js{4}
-export default {
- data () {
- return {
- msg: 'Highlighted!'
- }
- }
-}
-```
-
-In addition to a single line, you can also specify multiple single lines, ranges, or both:
-
-- Line ranges: for example `{5-8}`, `{3-10}`, `{10-17}`
-- Multiple single lines: for example `{4,7,9}`
-- Line ranges and single lines: for example `{4,7-13,16,23-27,40}`
-
-**Input**
-
-````
-```js{1,4,6-7}
-export default { // Highlighted
- data () {
- return {
- msg: `Highlighted!
- This line isn't highlighted,
- but this and the next 2 are.`,
- motd: 'VitePress is awesome',
- lorem: 'ipsum',
- }
- }
-}
-```
-````
-
-**Output**
-
-```js{1,4,6-8}
-export default { // Highlighted
- data () {
- return {
- msg: `Highlighted!
- This line isn't highlighted,
- but this and the next 2 are.`,
- motd: 'VitePress is awesome',
- lorem: 'ipsum',
- }
- }
-}
-```
-
-## Line Numbers
-
-You can enable line numbers for each code blocks via config:
-
-```js
-module.exports = {
- markdown: {
- lineNumbers: true
- }
-}
-```
-
-- Demo:
-
-
-
-
-
-
-
-
-
-
-
-
-
-## Import Code Snippets
-
-You can import code snippets from existing files via following syntax:
-
-```md
-<<< @/filepath
-```
-
-It also supports [line highlighting](#line-highlighting-in-code-blocks):
-
-```md
-<<< @/filepath{highlightLines}
-```
-
-**Input**
-
-```md
-<<< @/snippets/snippet.js{2}
-```
-
-**Code file**
-
-
-
-<<< @/snippets/snippet.js
-
-
-
-**Output**
-
-
-
-<<< @/snippets/snippet.js{2}
-
-
-
-::: tip
-The value of `@` corresponds to the source root. By default it's the VitePress project root, unless `srcDir` is configured.
-:::
-
-You can also use a [VS Code region](https://code.visualstudio.com/docs/editor/codebasics#_folding) to only include the corresponding part of the code file. You can provide a custom region name after a `#` following the filepath (`snippet` by default):
-
-**Input**
-
-```md
-<<< @/snippets/snippet-with-region.js{1}
-```
-
-**Code file**
-
-
-
-<<< @/snippets/snippet-with-region.js
-
-
-
-**Output**
-
-
-
-<<< @/snippets/snippet-with-region.js#snippet{1}
-
-
-
-## Advanced Configuration
-
-VitePress uses [markdown-it](https://github.com/markdown-it/markdown-it) as the Markdown renderer. A lot of the extensions above are implemented via custom plugins. You can further customize the `markdown-it` instance using the `markdown` option in `.vitepress/config.js`:
-
-```js
-const anchor = require('markdown-it-anchor')
-
-module.exports = {
- markdown: {
- // options for markdown-it-anchor
- // https://github.com/valeriangalliat/markdown-it-anchor#permalinks
- anchor: {
- permalink: anchor.permalink.headerLink()
- },
-
- // options for markdown-it-table-of-contents
- toc: { includeLevel: [1, 2] },
-
- config: (md) => {
- // use more markdown-it plugins!
- md.use(require('markdown-it-xxx'))
- }
- }
-}
-```
diff --git a/docs/guide/theming.md b/docs/guide/theming.md
deleted file mode 100644
index 6e1e349f..00000000
--- a/docs/guide/theming.md
+++ /dev/null
@@ -1,155 +0,0 @@
-# Theming
-
-## Using a Custom Theme
-
-You can enable a custom theme by adding the `.vitepress/theme/index.js` file (the "theme entry file").
-
-```bash
-.
-├─ docs
-│ ├─ .vitepress
-│ │ ├─ theme
-│ │ │ └─ index.js
-│ │ └─ config.js
-│ └─ index.md
-└─ package.json
-```
-
-A VitePress custom theme is simply an object containing three properties and is defined as follows:
-
-```ts
-interface Theme {
- Layout: Component // Vue 3 component
- NotFound?: Component
- enhanceApp?: (ctx: EnhanceAppContext) => void
-}
-
-interface EnhanceAppContext {
- app: App // Vue 3 app instance
- router: Router // VitePress router instance
- siteData: Ref
-}
-```
-
-The theme entry file should export the theme as its default export:
-
-```js
-// .vitepress/theme/index.js
-import Layout from './Layout.vue'
-
-export default {
- Layout,
- NotFound: () => 'custom 404', // <- this is a Vue 3 functional component
- enhanceApp({ app, router, siteData }) {
- // app is the Vue 3 app instance from `createApp()`. router is VitePress'
- // custom router. `siteData` is a `ref` of current site-level metadata.
- }
-}
-```
-
-...where the `Layout` component could look like this:
-
-```vue
-
-
-
Custom Layout!
-
-
-```
-
-The default export is the only contract for a custom theme. Inside your custom theme, it works just like a normal Vite + Vue 3 application. Do note the theme also needs to be [SSR-compatible](./using-vue#browser-api-access-restrictions).
-
-To distribute a theme, simply export the object in your package entry. To consume an external theme, import and re-export it from the custom theme entry:
-
-```js
-// .vitepress/theme/index.js
-import Theme from 'awesome-vitepress-theme'
-export default Theme
-```
-
-## Extending the Default Theme
-
-If you want to extend and customize the default theme, you can import it from `vitepress/theme` and augment it in a custom theme entry. Here are some examples of common customizations:
-
-### Registering Global Components
-
-```js
-// .vitepress/theme/index.js
-import DefaultTheme from 'vitepress/theme'
-
-export default {
- ...DefaultTheme,
- enhanceApp({ app }) {
- // register global components
- app.component('MyGlobalComponent' /* ... */)
- }
-}
-```
-
-Since we are using Vite, you can also leverage Vite's [glob import feature](https://vitejs.dev/guide/features.html#glob-import) to auto register a directory of components.
-
-### Customizing CSS
-
-The default theme CSS is customizable by overriding root level CSS variables:
-
-```js
-// .vitepress/theme/index.js
-import DefaultTheme from 'vitepress/theme'
-import './custom.css'
-
-export default DefaultTheme
-```
-
-```css
-/* .vitepress/theme/custom.css */
-:root {
- --c-brand: #646cff;
- --c-brand-light: #747bff;
-}
-```
-
-See [default theme CSS variables](https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css) that can be overridden.
-
-### Layout Slots
-
-The default theme's `` component has a few slots that can be used to inject content at certain locations of the page. Here's an example of injecting a component into the top of the sidebar:
-
-```js
-// .vitepress/theme/index.js
-import DefaultTheme from 'vitepress/theme'
-import MyLayout from './MyLayout.vue'
-
-export default {
- ...DefaultTheme,
- // override the Layout with a wrapper component that injects the slots
- Layout: MyLayout
-}
-```
-
-```vue
-
-
-
-
-
- My custom sidebar top content
-
-
-```
-
-Full list of slots available in the default theme layout:
-
-- `navbar-search`
-- `sidebar-top`
-- `sidebar-bottom`
-- `page-top-ads`
-- `page-top`
-- `page-bottom`
-- `page-bottom-ads`
-- Only when `home: true` is enabled via frontmatter:
- - `home-hero`
- - `home-features`
- - `home-footer`
diff --git a/docs/guide/using-vue.md b/docs/guide/using-vue.md
deleted file mode 100644
index d6d5ce7c..00000000
--- a/docs/guide/using-vue.md
+++ /dev/null
@@ -1,261 +0,0 @@
----
-sidebarDepth: 3
----
-
-# Using Vue in Markdown
-
-In VitePress, each markdown file is compiled into HTML and then processed as a Vue Single-File Component. This means you can use any Vue features inside the markdown, including dynamic templating, using Vue components, or arbitrary in-page Vue component logic by adding a `
-
-
{{ page }}
-```
-
-**Output**
-
-```json
-{
- "path": "/using-vue.html",
- "title": "Using Vue in Markdown",
- "frontmatter": {}
-}
-```
-
-## Escaping
-
-By default, fenced code blocks are automatically wrapped with `v-pre`. To display raw mustaches or Vue-specific syntax inside inline code snippets or plain text, you need to wrap a paragraph with the `v-pre` custom container:
-
-**Input**
-
-```md
-::: v-pre
-`{{ This will be displayed as-is }}`
-:::
-```
-
-**Output**
-
-::: v-pre
-`{{ This will be displayed as-is }}`
-:::
-
-## Using Components
-
-When you need to have more flexibility, VitePress allows you to extend your authoring toolbox with your own Vue Components.
-
-### Importing components in markdown
-
-If your components are going to be used in only a few places, the recommended way to use them is to importing the components in the file where it is used.
-
-```md
-
-
-# Docs
-
-This is a .md using a custom component
-
-
-
-## More docs
-
-...
-```
-
-### Registering global components in the theme
-
-If the components are going to be used across several pages in the docs, they can be registered globally in the theme (or as part of extending the default VitePress theme). Check out the [Theming Guide](./theming) for more information.
-
-In `.vitepress/theme/index.js`, the `enhanceApp` function receives the Vue `app` instance so you can [register components](https://vuejs.org/guide/components/registration.html) as you would do in a regular Vue application.
-
-```js
-import DefaultTheme from 'vitepress/theme'
-
-export default {
- ...DefaultTheme,
- enhanceApp({ app }) {
- app.component('VueClickAwayExample', VueClickAwayExample)
- }
-}
-```
-
-Later in your markdown files, the component can be interleaved between the content
-
-```md
-# Vue Click Away
-
-
-```
-
-::: warning IMPORTANT
-Make sure a custom component’s name either contains a hyphen or is in PascalCase. Otherwise, it will be treated as an inline element and wrapped inside a `
` tag, which will lead to hydration mismatch because `
` does not allow block elements to be placed inside it.
-:::
-
-### Using Components In Headers
-
-You can use Vue components in the headers, but note the difference between the following syntaxes:
-
-| Markdown | Output HTML | Parsed Header |
-| ------------------------------------------------------- | ----------------------------------------- | ------------- |
-|
# text <Tag/>
| `
text
` | `text` |
-|
# text \`<Tag/>\`
| `
text <Tag/>
` | `text ` |
-
-The HTML wrapped by `` will be displayed as-is; only the HTML that is **not** wrapped will be parsed by Vue.
-
-::: tip
-The output HTML is accomplished by [markdown-it](https://github.com/markdown-it/markdown-it), while the parsed headers are handled by VitePress (and used for both the sidebar and document title).
-:::
-
-## Using CSS Pre-processors
-
-VitePress has [built-in support](https://vitejs.dev/guide/features.html#css-pre-processors) for CSS pre-processors: `.scss`, `.sass`, `.less`, `.styl` and `.stylus` files. There is no need to install Vite-specific plugins for them, but the corresponding pre-processor itself must be installed:
-
-```
-# .scss and .sass
-npm install -D sass
-
-# .less
-npm install -D less
-
-# .styl and .stylus
-npm install -D stylus
-```
-
-Then you can use the following in Markdown and theme components:
-
-```vue
-
-```
-
-## Script & Style Hoisting
-
-Sometimes you may need to apply some JavaScript or CSS only to the current page. In those cases, you can directly write root-level `
-
-## Built-In Components
-
-VitePress provides Built-In Vue Components like `ClientOnly` and `OutboundLink`, check out the [Global Component Guide](./global-component) for more information.
-
-**Also see:**
-
-- [Using Components In Headers](#using-components-in-headers)
-
-## Browser API Access Restrictions
-
-Because VitePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the [universal code requirements](https://vuejs.org/guide/scaling-up/ssr.html). In short, make sure to only access Browser / DOM APIs in `beforeMount` or `mounted` hooks.
-
-If you are using or demoing components that are not SSR-friendly (for example, contain custom directives), you can wrap them inside the built-in `` component:
-
-```md
-
-
-
-```
-
-Note this does not fix components or libraries that access Browser APIs **on import**. To use code that assumes a browser environment on import, you need to dynamically import them in proper lifecycle hooks:
-
-```vue
-
-```
-
-If your module `export default` a Vue component, you can register it dynamically:
-
-```vue
-
-
-
-
-
-```
-
-**Also see:**
-
-- [Vue.js > Dynamic Components](https://vuejs.org/guide/essentials/component-basics.html#dynamic-components)
diff --git a/docs/guide/what-is-vitepress.md b/docs/guide/what-is-vitepress.md
new file mode 100644
index 00000000..204c91b3
--- /dev/null
+++ b/docs/guide/what-is-vitepress.md
@@ -0,0 +1,3 @@
+# What is VitePress?
+
+Coming soon...
diff --git a/docs/images/line-numbers-desktop.png b/docs/images/line-numbers-desktop.png
deleted file mode 100644
index e16e6707..00000000
Binary files a/docs/images/line-numbers-desktop.png and /dev/null differ
diff --git a/docs/images/line-numbers-mobile.gif b/docs/images/line-numbers-mobile.gif
deleted file mode 100644
index 87af6cf0..00000000
Binary files a/docs/images/line-numbers-mobile.gif and /dev/null differ
diff --git a/docs/images/vercel-configuration.png b/docs/images/vercel-configuration.png
deleted file mode 100644
index 51874e15..00000000
Binary files a/docs/images/vercel-configuration.png and /dev/null differ
diff --git a/docs/index.md b/docs/index.md
index 092840b8..5039610d 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,56 +1,3 @@
----
-sidebarDepth: 2
----
+# Home Page
-# What is VitePress?
-
-::: warning WARNING
-VitePress is currently in 0.x status. It is already suitable for out-of-the-box documentation use, but the config and theming API may still change between minor releases.
-:::
-
-VitePress is [VuePress](https://vuepress.vuejs.org)' little brother, built on top of [Vite](https://github.com/vitejs/vite).
-
-## Motivation
-
-We love VuePress v1, but being built on top of Webpack, the time it takes to spin up the dev server for a simple doc site with a few pages is just becoming unbearable. Even HMR updates can take up to seconds to reflect in the browser!
-
-Fundamentally, this is because VuePress v1 is a Webpack app under the hood. Even with just two pages, it's a full on Webpack project (including all the theme source files) being compiled. It gets even worse when the project has many pages – every page must first be fully compiled before the server can even display anything!
-
-Incidentally, Vite solves these problems really well: nearly instant server start, an on-demand compilation that only compiles the page being served, and lightning-fast HMR. Plus, there are a few additional design issues I have noted in VuePress v1 over time but never had the time to fix due to the amount of refactoring it would require.
-
-Now, with Vite and Vue 3, it is time to rethink what a "Vue-powered static site generator" can really be.
-
-## Improvements Over VuePress v1
-
-There're couple of things that are improved from VuePress v1....
-
-### It Uses Vue 3
-
-Leverages Vue 3's improved template static analysis to stringify static content as much as possible. Static content is sent as string literals instead of JavaScript render function code – the JS payload is therefore _much_ cheaper to parse, and hydration also becomes faster.
-
-Note the optimization is applied while still allowing the user to freely mix Vue components inside markdown content – the compiler does the static/dynamic separation for you automatically and you never need to think about it.
-
-### It Uses Vite Under The Hood
-
-- Faster dev server start
-- Faster hot updates
-- Faster build (uses Rollup internally)
-
-### Lighter Page Weight
-
-- Vue 3 tree-shaking + Rollup code splitting
-- Does not ship metadata for every page on every request. This decouples page weight from total number of pages. Only the current page's metadata is sent. Client side navigation fetches the new page's component and metadata together.
-- Does not use `vue-router` because the need of VitePress is very simple and specific - a simple custom router (under 200 LOC) is used instead.
-- (WIP) i18n locale data should also be fetched on demand.
-
-## Other Differences
-
-VitePress is more opinionated and less configurable: VitePress aims to scale back the complexity in the current VuePress and restart from its minimalist roots.
-
-VitePress is future oriented: VitePress only targets browsers that support native ES module imports. It encourages the use of native JavaScript without transpilation, and CSS variables for theming.
-
-## Will This Become The Next VuePress in The Future?
-
-We already have [vuepress-next](https://github.com/vuepress/vuepress-next), which would be the next major version of VuePress. It also makes lots of improvements over VuePress v1, and also supports Vite now.
-
-VitePress is not compatible with the current VuePress ecosystem (mostly themes and plugins). The overall idea is that VitePress will have a drastically more minimal theming API (preferring JavaScript APIs instead of file layout conventions) and likely no plugins (all customization is done in themes).
+Coming soon...
diff --git a/docs/snippets/snippet-with-region.js b/docs/snippets/snippet-with-region.js
deleted file mode 100644
index 9c7faaeb..00000000
--- a/docs/snippets/snippet-with-region.js
+++ /dev/null
@@ -1,7 +0,0 @@
-// #region snippet
-function foo() {
- // ..
-}
-// #endregion snippet
-
-export default foo
diff --git a/docs/snippets/snippet.js b/docs/snippets/snippet.js
deleted file mode 100644
index 575039d1..00000000
--- a/docs/snippets/snippet.js
+++ /dev/null
@@ -1,3 +0,0 @@
-export default function () {
- // ..
-}
diff --git a/package.json b/package.json
index 6e1cb106..ea0fb88a 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "vitepress",
- "version": "0.22.4",
+ "version": "1.0.0-draft.1",
"description": "Vite & Vue powered static site generator",
"main": "dist/node/index.js",
"typings": "types/index.d.ts",
@@ -14,6 +14,24 @@
"client.d.ts",
"theme.d.ts"
],
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/vuejs/vitepress.git"
+ },
+ "keywords": [
+ "vite",
+ "vue",
+ "vitepress"
+ ],
+ "author": "Evan You",
+ "license": "MIT",
+ "homepage": "https://github.com/vuejs/vitepress/tree/main/#readme",
+ "bugs": {
+ "url": "https://github.com/vuejs/vitepress/issues"
+ },
+ "engines": {
+ "node": ">=14.0.0"
+ },
"scripts": {
"dev": "run-s dev-shared dev-start",
"dev-start": "run-p dev-client dev-node dev-watch",
@@ -31,7 +49,8 @@
"lint": "run-s lint:js lint:ts",
"lint:js": "prettier --check --write \"{bin,docs,scripts,src}/**/*.js\"",
"lint:ts": "prettier --check --write --parser typescript \"{__tests__,src,docs,types}/**/*.ts\"",
- "test": "vitest run __tests__ -c __tests__/vitest.config.js --globals",
+ "test": "vitest run __tests__ -c __tests__/vitest.config.js --global",
+ "test:all": "run-s lint test",
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
"release": "node scripts/release.js",
"docs": "run-p dev docs-dev",
@@ -42,9 +61,6 @@
"docs-serve": "node ./bin/vitepress serve docs",
"ci-docs": "run-s build docs-build"
},
- "engines": {
- "node": ">=14.0.0"
- },
"gitHooks": {
"pre-commit": "lint-staged"
},
@@ -56,28 +72,15 @@
"prettier --parser=typescript --write"
]
},
- "repository": {
- "type": "git",
- "url": "git+https://github.com/vuejs/vitepress.git"
- },
- "keywords": [
- "vite",
- "vue",
- "vitepress"
- ],
- "author": "Evan You",
- "license": "MIT",
- "homepage": "https://github.com/vuejs/vitepress/tree/master/#readme",
- "bugs": {
- "url": "https://github.com/vuejs/vitepress/issues"
- },
"dependencies": {
"@docsearch/css": "^3.0.0",
"@docsearch/js": "^3.0.0",
"@vitejs/plugin-vue": "^2.3.2",
+ "@vueuse/core": "^8.5.0",
+ "body-scroll-lock": "^4.0.0-beta.0",
"prismjs": "^1.25.0",
"vite": "^2.9.7",
- "vue": "^3.2.33"
+ "vue": "3.2.33"
},
"devDependencies": {
"@microsoft/api-extractor": "^7.23.1",
@@ -85,6 +88,7 @@
"@rollup/plugin-commonjs": "^20.0.0",
"@rollup/plugin-json": "^4.1.0",
"@rollup/plugin-node-resolve": "^13.0.4",
+ "@types/body-scroll-lock": "^3.1.0",
"@types/compression": "^1.7.0",
"@types/cross-spawn": "^6.0.2",
"@types/debug": "^4.1.7",
diff --git a/src/client/app/components/ClientOnly.ts b/src/client/app/components/ClientOnly.ts
index 2e1da7c3..e7b1f17e 100644
--- a/src/client/app/components/ClientOnly.ts
+++ b/src/client/app/components/ClientOnly.ts
@@ -1,11 +1,13 @@
-import { ref, onMounted, defineComponent } from 'vue'
+import { defineComponent, ref, onMounted } from 'vue'
export const ClientOnly = defineComponent({
setup(_, { slots }) {
const show = ref(false)
+
onMounted(() => {
show.value = true
})
+
return () => (show.value && slots.default ? slots.default() : null)
}
})
diff --git a/src/client/app/index.ts b/src/client/app/index.ts
index ea5fe60c..96052d19 100644
--- a/src/client/app/index.ts
+++ b/src/client/app/index.ts
@@ -7,11 +7,11 @@ import {
onMounted,
watch
} from 'vue'
+import Theme from '/@theme/index'
import { inBrowser, pathToFile } from './utils'
import { Router, RouterSymbol, createRouter } from './router'
import { siteDataRef, useData } from './data'
import { useUpdateHead } from './composables/head'
-import Theme from '/@theme/index'
import { usePrefetch } from './composables/preFetch'
import { dataSymbol, initData } from './data'
import { Content } from './components/Content'
diff --git a/src/client/shim.d.ts b/src/client/shim.d.ts
index c6c262e5..2d25724b 100644
--- a/src/client/shim.d.ts
+++ b/src/client/shim.d.ts
@@ -1,7 +1,8 @@
declare const __VP_HASH_MAP__: Record
+declare const __ALGOLIA__: boolean
declare const __CARBON__: boolean
declare const __BSA__: boolean
-declare const __ALGOLIA__: boolean
+
declare module '*.vue' {
import { ComponentOptions } from 'vue'
const comp: ComponentOptions
@@ -13,7 +14,7 @@ declare module '@siteData' {
export default data
}
-// this module's typing is broken
+// this module's typing is broken.
declare module '@docsearch/js' {
function docsearch(props: T): void
export default docsearch
diff --git a/src/client/theme-default/Layout.vue b/src/client/theme-default/Layout.vue
index 26ba9b4c..a890b801 100644
--- a/src/client/theme-default/Layout.vue
+++ b/src/client/theme-default/Layout.vue
@@ -1,189 +1,31 @@
-
-
-