Skip to content

README.md

Latest commit

 

History

History
72 lines (45 loc) · 1.54 KB

README.md

File metadata and controls

72 lines (45 loc) · 1.54 KB

pgmoneta website

This repository hosts the source for the VitePress-based website for the pgmoneta project.

Prerequisites

Before you begin, ensure you have the following installed:

Getting Started

Follow these steps to get your local development environment set up:

1. Clone the Repository

git clone https://github.com/pgmoneta/pgmoneta.github.io.git
cd pgmoneta.github.io

2. Install Dependencies

Install the necessary dependencies:

pnpm install

3. Start the Development Server

To start the local development server and begin working on the VitePress site, run:

pnpm dev

By default, the dev server runs at http://localhost:5173/.

4. Build the Site

To generate the production build, run:

pnpm build

5. Preview the Production Build

To serve the generated site locally after building it, run:

pnpm preview

6. Sync the Imported Documentation

The documentation under doc/ is fetched from the upstream pgmoneta repository. To refresh the site content:

  1. Set the desired tag value in scripts/fetch-docs.mjs (the TAG constant)
  2. Run the sync command:
pnpm sync-docs

This script automatically fetches the documentation from the configured source and updates the doc/ folder in the website.

License

This work is licensed according to the terms of the Creative Commons Attribution 4.0 International License