June 26, 2020

748 words 4 mins read

vuejs/vitepress

vuejs/vitepress

Vite & Vue powered static site generator

repo name vuejs/vitepress
repo link https://github.com/vuejs/vitepress
homepage
language TypeScript
size (curr.) 258 kB
stars (curr.) 1401
created 2020-04-30
license MIT License

(WIP) VitePress 📝💨

VuePress’ little brother, built on top of vite

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.

npm install -D vitepress
echo '# Hello VitePress' > index.md

# starts dev server
npx vitepress

# build > .vitepress/dist
npx vitepress build

Customization

Configuration can be done via .vitepress/config.js (see src/node/config.ts)

You can develop your custom theme by adding the following files:

.vitepress/theme/Layout.vue

<template>
  <h1>Custom Layout!</h1>
  <Content/><!-- make sure to include markdown outlet -->
</template>

.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 (see `lib/app/router.js`)
    // siteData is a ref of current site-level metadata.
  }
}

Unlike VuePress, the only file with a fixed location in a theme is index.js - everything else is imported and exported there like in a normal application.

Motivation

I love VuePress, 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!

As a reference, the Composition API RFC repo is just two pages, but it takes 4 seconds to spin up the server, and almost 2 seconds for any edit to reflect in the browser.

Fundamentally, this is because VuePress 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, 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 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

  • 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.

  • 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

  • More opinionated and less configurable: VitePress aims to scale back the complexity in the current VuePress and restart from its minimalist roots.

  • 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?

Maybe! It’s currently under a different name so that we don’t over commit to the compatibility with the current VuePress ecosystem (mostly themes and plugins). We’ll see how close we can get without compromising the design goals listed above. But 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).

Want to contribute?

Check out our contributing guide for more information!

License

MIT

comments powered by Disqus