Skip to content

VitePress

VitePress turns Markdown files into a documentation site with a Vue-based theme.

Visit VitePress

What should you install before editing?

Check the guide for the VitePress version you choose. The stable 1.6.4 guide requires Node.js 18 or higher, while the current 2.0 preview guide lists Node.js 22 or higher. Use a currently maintained Node release that meets your chosen version’s requirements. Start with one Markdown file and the default theme.

What do you send to the host?

Build the docs and serve the generated output folder. Keep the Markdown and configuration in your source project so you can build again after an edit. VitePress uses the MIT license. You arrange hosting separately and should check links at the address where the site will actually live.

How would you move a guide under a different menu?

Sketch this with fictional material. Leave the real site, accounts and services alone.

  1. Draw the old and new links
    Move a fictional Change your address guide from Setup to Account. Mark the old URL a reader might have saved.
  2. Plan the navigation update
    Write the menu label and one related page that must link to the new location.
  3. Choose the reader check
    List the old URL, new URL and one phrase to search for after the site is rebuilt.