feat: VitePress for docs

VitePress is configured in the repo for handling docs

.gitignore

@@ -28,3 +28,7 @@ venv
 
 # NodeJS
 node_modules
+
+# VitePress
+**/.vitepress/dist
+**/.vitepress/cache

docs/.vitepress/config.mts

@@ -0,0 +1,27 @@
+import { defineConfig } from "vitepress";
+import { withSidebar } from "vitepress-sidebar";
+
+// https://vitepress.dev/reference/site-config
+const vitePressOptions = {
+  title: "Frappe Docker Docs",
+  description: "Frappe in a Container",
+  themeConfig: {
+    logo: "../images/frappe_docker.png",
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [{ text: "Home", link: "/" }],
+
+    socialLinks: [
+      { icon: "github", link: "https://github.com/frappe/frappe_docker/" },
+    ],
+  },
+};
+
+const vitePressSidebarOptions = {
+  documentRootPath: "./docs",
+  useTitleFromFrontmatter: true,
+  useFolderTitleFromIndexFile: true,
+};
+
+export default defineConfig(
+  withSidebar(vitePressOptions, vitePressSidebarOptions)
+);

docs/01-getting-started/03-arm64.md

@@ -1,3 +1,7 @@
+---
+title: Quick Start with Linux and Mac
+---
+
 # How to install ERPNext on linux/mac using Frappe_docker ?
 
 ## Clone the repo

docs/01-getting-started/04-single-compose-setup.md

@@ -1,3 +1,7 @@
+---
+title: Single Compose Setup
+---
+
 # Single Compose Setup
 
 This setup is a very simple single compose file that does everything to start required services and a frappe-bench. It is used to start play with docker instance with a site. The file is located in the root of repo and named `pwd.yml`.

docs/01-getting-started/index.md

@@ -0,0 +1,3 @@
+---
+title: Getting Started
+---

docs/02-setup/01-overview.md

@@ -1,3 +1,7 @@
+---
+title: Setup Overview
+---
+
 The purpose of this document is to give you an overview of how the Frappe Docker containers are structured.
 
 # 🐳 Images

docs/02-setup/02-build-setup.md

@@ -1,3 +1,7 @@
+---
+title: Build Setup
+---
+
 This guide walks you through building Frappe images from the repository resources.
 
 # Prerequisites

docs/02-setup/03-start-setup.md

@@ -1,3 +1,7 @@
+---
+title: Start Container
+---
+
 # start Container
 
 Once your compose file is ready, start all containers with a single command:

docs/02-setup/04-env-variables.md

@@ -1,3 +1,7 @@
+---
+title: Environment Variables
+---
+
 # Environment Variables Reference
 
 Environment variables configure your Frappe Docker setup. They can be set directly in the container or defined in a `.env` file referenced by Docker Compose.

docs/02-setup/05-overrides.md

@@ -1,3 +1,7 @@
+---
+title: Overrides
+---
+
 Overrides extend the base compose.yaml with additional services or modify existing behavior. Include them in your compose command using multiple -f flags.
 
 ```bash

docs/02-setup/06-setup-examples.md

@@ -1,3 +1,7 @@
+---
+title: Setup Examples
+---
+
 # Setup Examples
 
 This guide provides practical examples for common setup scenarios. These examples build upon the [container setup guide](01-overview.md) and demonstrate how to combine the base compose file with overrides.

docs/02-setup/07-single-server-example.md

@@ -1,3 +1,7 @@
+---
+title: Single Server Setup
+---
+
 # Single Server Example
 
 This guide demonstrates setting up multiple Frappe/ERPNext benches (projects) on a single server with shared infrastructure components.

docs/02-setup/index.md

@@ -0,0 +1,3 @@
+---
+title: Setup
+---

docs/03-production/01-tls-ssl-setup.md

@@ -1,4 +1,8 @@
-# TLS/SSL Setup Overview
+---
+title: TLS/SSL Setup Overview
+---
+
+# Accessing ERPNext through https on local deployment
 
 Frappe Docker supports multiple TLS/SSL approaches. Choose the one that matches your routing needs and where you want the proxy to run.
 

docs/03-production/02-backup-strategy.md

@@ -1,3 +1,7 @@
+---
+title: Backup Strategy
+---
+
 Create backup service or stack.
 
 ```yaml

docs/03-production/03-multi-tenancy.md

@@ -1,3 +1,7 @@
+---
+title: Multi Tenancy
+---
+
 WARNING: Do not use this in production if the site is going to be served over plain http.
 
 ### Step 1

docs/03-production/index.md

@@ -0,0 +1,3 @@
+---
+title: Production
+---

docs/04-operations/01-site-operations.md

@@ -1,3 +1,7 @@
+---
+title: Site Operations
+---
+
 # Site operations
 
 > 💡 You should setup `--project-name` option in `docker-compose` commands if you have non-standard project name.

docs/04-operations/index.md

@@ -0,0 +1,3 @@
+---
+title: Operations
+---

docs/05-development/01-development.md

@@ -1,3 +1,7 @@
+---
+title: Getting Started
+---
+
 # Getting Started
 
 ## Prerequisites

docs/05-development/02-debugging.md

@@ -1,3 +1,7 @@
+---
+title: Debugging
+---
+
 Add the following configuration to `launch.json` `configurations` array to start bench console and use debugger. Replace `development.localhost` with appropriate site. Also replace `frappe-bench` with name of the bench directory.
 
 ```json

docs/05-development/03-local-services-connection.md

@@ -1,3 +1,7 @@
+---
+title: Local Services
+---
+
 Add following to frappe container from the `.devcontainer/docker-compose.yml`:
 
 ```yaml

docs/05-development/index.md

@@ -0,0 +1,3 @@
+---
+title: Development
+---

docs/06-migration/01-migrate-from-multi-image-setup.md

@@ -1,3 +1,7 @@
+---
+title: Migrate from Multi Image Setup
+---
+
 ## Migrate from multi-image setup
 
 All the containers now use same image. Use `frappe/erpnext` instead of `frappe/frappe-worker`, `frappe/frappe-nginx` , `frappe/frappe-socketio` , `frappe/erpnext-worker` and `frappe/erpnext-nginx`.

docs/06-migration/index.md

@@ -0,0 +1,3 @@
+---
+title: Migration
+---

docs/07-troubleshooting/01-troubleshoot.md

@@ -1,6 +1,11 @@
-1. [Fixing MariaDB issues after rebuilding the container](#fixing-mariadb-issues-after-rebuilding-the-container)
+---
-1. [docker-compose does not recognize variables from `.env` file](#docker-compose-does-not-recognize-variables-from-env-file)
+title: Troubleshoot
-1. [Windows Based Installation](#windows-based-installation)
+---
+
+- [Fixing MariaDB issues after rebuilding the container](#fixing-mariadb-issues-after-rebuilding-the-container)
+- [docker-compose does not recognize variables from `.env` file](#docker-compose-does-not-recognize-variables-from-env-file)
+- [Windows Based Installation](#windows-based-installation)
+- [Redo installation](#redo-installation)
 
 ### Fixing MariaDB issues after rebuilding the container
 

docs/07-troubleshooting/02-windows-nginx-entrypoint-error.md

@@ -1,3 +1,7 @@
+---
+title: NGINX in Windows
+---
+
 # Resolving Docker `nginx-entrypoint.sh` Script Not Found Error on Windows
 
 If you're encountering the error `exec /usr/local/bin/nginx-entrypoint.sh: no such file or directory` in a Docker container on Windows, follow these steps to resolve the issue.

docs/07-troubleshooting/index.md

@@ -0,0 +1,3 @@
+---
+title: Troubleshooting
+---

docs/08-reference/01-build-version-10-images.md

@@ -1,3 +1,7 @@
+---
+title: Build Version 10
+---
+
 Clone the version-10 branch of this repo
 
 ```shell

docs/08-reference/index.md

@@ -0,0 +1,3 @@
+---
+title: References
+---

docs/getting-started.md

@@ -1,3 +1,7 @@
+---
+title: Getting Started
+---
+
 # Getting Started with Frappe Docker
 
 _A comprehensive guide for developers getting started with Frappe Docker, with comparisons to Django for teams familiar with that framework_

docs/index.md

@@ -0,0 +1,26 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "Frappe in Docker"
+  # text: "Frappe in Container"
+  tagline: "Documentation to use Docker based setup of Frappe framework"
+  image:
+    src: ./images/frappe_docker.png
+  actions:
+    - theme: brand
+      text: Getting Started
+      link: /getting-started
+    - theme: alt
+      text: Single Compose Setup
+      link: /01-getting-started/02-single-compose-setup
+
+features:
+  - title: Containerised
+    details: All the power of Frappe, but in the container
+  - title: Setup in Minutes
+    details: Get it started in a few minutes
+  - title: Production Ready
+    details: Deploy production applications with ease
+---

package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "vitepress": "2.0.0-alpha.15",
+    "vitepress-sidebar": "^1.33.1"
+  },
+  "scripts": {
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  }
+}