Skip to Content
Vuesho

Quick Start

Create a docs site from an empty folder.

You need Node.js 24 or later.

Creating a Site

Install the Packages

In an empty folder, install vuesho with Vue and Vite:

npm i vuesho vue
npm i -D vite

Then add the scripts to package.json:

package.json
{
  "type": "module",
  "scripts": {
    "dev": "vuesho dev",
    "build": "vuesho build",
    "preview": "vuesho preview"
  }
}

The vuesho command runs Vite with the Vuesho plugin, which sets up Vue and Nitro. The site needs no vite.config.ts and no index.html.

Write a Page

Each Markdown file under content/ is a page:

content/index.md
---
title: Hello
description: My first page.
---

## Getting Started

Welcome to the docs.

See Markdown for the syntax of a page.

Start the Dev Server

npm run dev

Open the URL Vite prints. The page reloads when you edit it, and the sidebar updates when you add or remove a file.

Building

npm run build

vuesho build writes the site to .output:

  • .output/public has every page as HTML, with the assets, the search index and the sitemap.
  • .output/server has a Nitro server, for the routes that render on demand.

A site with only Markdown content works from .output/public on any static host. To check the build locally, run npm run preview. See Deploy to put it online.

TypeScript

A site needs no TypeScript. To type-check your config, theme and pages, install typescript@6, vue-tsc and @types/node, and add a tsconfig.json:

tsconfig.json
{
  "compilerOptions": {
    "target": "ES2023",
    "lib": ["ES2023", "DOM", "DOM.Iterable"],
    "module": "ESNext",
    "moduleResolution": "Bundler",
    "strict": true,
    "noEmit": true,
    "skipLibCheck": true,
    "types": ["node", "vite/client"]
  },
  "include": ["*.ts", "src"]
}

Then run npx vue-tsc --noEmit. It checks the UI of the package with your files, which is written for ES2023, so lib can't be older. vuesho.config.ts and vite.config.ts run in Node.js, so "node" in types gives them its globals, like process.env.

vue-tsc runs on the JavaScript API of TypeScript, which TypeScript 7 doesn't have, so install TypeScript 6. Vue's compiler needs it too for a component of yours whose defineProps() takes a type imported from a package; a type of your own files needs no TypeScript.

Next Steps