ProxMenux/web/README.md
2025-02-13 23:04:40 +01:00

778 B

ProxMenux

ProxMenux is a menu-driven script for Proxmox VE management. This repository contains both the core ProxMenux tool and its documentation website.

Project Structure

  • /web: Contains the Next.js website for ProxMenux documentation
  • /guides: Markdown files for various guides
  • CHANGELOG.md: Project changelog

Getting Started

To run the documentation website locally:

  1. Navigate to the /web directory
  2. Install dependencies: npm install
  3. Run the development server: npm run dev

Deployment

This project is set up for automatic deployment to GitHub Pages using GitHub Actions. Any push to the main branch will trigger a new build and deployment.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.