Skip to content

GEOLYTIX/xyz-docs

Repository files navigation

XYZ Project Planning

A documentation site powered by VitePress.

Getting Started

This project uses pnpm as its package manager.

Install dependencies

pnpm install

Local Development

Start the VitePress development server:

pnpm dev

The site will be available at the local address printed in your terminal.

Build for Production

Generate the static site for production:

pnpm build

Preview Production Build

Preview the production build locally:

pnpm preview

Project Structure

  • .vitepress/ — VitePress configuration and theme files
  • index.md — Main entry point for documentation
  • release/ — Release notes and changelogs
  • sitrep/ — Situation reports or additional documentation
  • api-examples.md, markdown-examples.md — Example documentation pages

Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

Releases

No releases published

Packages

 
 
 

Contributors