diff --git a/web/CHANGELOG.md b/web/CHANGELOG.md new file mode 100644 index 0000000..e8ec34e --- /dev/null +++ b/web/CHANGELOG.md @@ -0,0 +1,34 @@ +# Changelog + +All notable changes to ProxMenux will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- Initial project setup +- Basic menu structure +- Documentation framework + +## [0.1.0] - 2023-06-15 + +### Added +- Core functionality for executing shell scripts +- Menu-driven interface for script selection +- Basic error handling and logging + +### Changed +- Improved script organization with categories + +### Fixed +- Issue with script permissions on certain systems + +## [0.0.1] - 2023-06-01 + +### Added +- Project initialization +- README with basic project description +- License file + diff --git a/web/README.md b/web/README.md new file mode 100644 index 0000000..746cbfc --- /dev/null +++ b/web/README.md @@ -0,0 +1,26 @@ +# 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. + diff --git a/web/app/changelog/changelog.md b/web/app/changelog/changelog.md new file mode 100644 index 0000000..e8ec34e --- /dev/null +++ b/web/app/changelog/changelog.md @@ -0,0 +1,34 @@ +# Changelog + +All notable changes to ProxMenux will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- Initial project setup +- Basic menu structure +- Documentation framework + +## [0.1.0] - 2023-06-15 + +### Added +- Core functionality for executing shell scripts +- Menu-driven interface for script selection +- Basic error handling and logging + +### Changed +- Improved script organization with categories + +### Fixed +- Issue with script permissions on certain systems + +## [0.0.1] - 2023-06-01 + +### Added +- Project initialization +- README with basic project description +- License file + diff --git a/web/app/changelog/page.tsx b/web/app/changelog/page.tsx new file mode 100644 index 0000000..92be156 --- /dev/null +++ b/web/app/changelog/page.tsx @@ -0,0 +1,24 @@ +import fs from "fs" +import path from "path" +import { remark } from "remark" +import html from "remark-html" + +async function getChangelog() { + const changelogPath = path.join(process.cwd(), "CHANGELOG.md") + const fileContents = fs.readFileSync(changelogPath, "utf8") + + const result = await remark().use(html).process(fileContents) + return result.toString() +} + +export default async function ChangelogPage() { + const changelogContent = await getChangelog() + + return ( +