feat: Implement Docusaurus documentation site

Author: involvex

docs/USAGE.md docs/docs/USAGE.mddocs/USAGE.md renamed to docs/docs/USAGE.md

@@ -1,3 +1,5 @@
+<!-- @format -->
+
 # Usage Guide for @involvex/create-wizard
 
 This document provides a detailed guide on how to use the `@involvex/create-wizard` CLI tool to create new JavaScript projects. This tool is designed to provide a comprehensive, all-in-one project configuration, streamlining project initialization, reducing manual setup, ensuring consistency, and accelerating developer onboarding.
@@ -41,17 +43,17 @@ Choose one of the available project templates. Each template provides a complete
 
 The selected template will scaffold the entire project structure. Here's a brief overview of each template:
 
-*   **`discord-bot`**: Sets up a basic Discord bot project with necessary `discord.js` dependencies and a starting `src/index.js`. Ideal for quickly getting a Discord bot development environment ready.
-*   **`nextjs`**: Configures a minimal Next.js application, including React, Next.js dependencies, and standard Next.js scripts (`dev`, `build`, `start`, `lint`). Perfect for starting server-rendered React applications.
-*   **`node-api`**: Provides a simple Node.js API structure, typically using Express. Includes basic routing and server setup. Great for backend development.
-*   **`react-app`**: Initializes a basic React application using Vite for fast development. Includes core React dependencies and a simple component structure.
-*   **`vite`**: Sets up a general-purpose Vite project. Vite is a fast build tool that provides a lean and efficient development experience.
-*   **`vuejs`**: Configures a Vue.js project, often integrated with Vite for rapid development. Includes core Vue dependencies and a basic application structure.
-*   **`webpack`**: Provides a foundational Webpack project setup. Useful for understanding and customizing build processes from scratch.
+- **`discord-bot`**: Sets up a basic Discord bot project with necessary `discord.js` dependencies and a starting `src/index.js`. Ideal for quickly getting a Discord bot development environment ready.
+- **`nextjs`**: Configures a minimal Next.js application, including React, Next.js dependencies, and standard Next.js scripts (`dev`, `build`, `start`, `lint`). Perfect for starting server-rendered React applications.
+- **`node-api`**: Provides a simple Node.js API structure, typically using Express. Includes basic routing and server setup. Great for backend development.
+- **`react-app`**: Initializes a basic React application using Vite for fast development. Includes core React dependencies and a simple component structure.
+- **`vite`**: Sets up a general-purpose Vite project. Vite is a fast build tool that provides a lean and efficient development experience.
+- **`vuejs`**: Configures a Vue.js project, often integrated with Vite for rapid development. Includes core Vue dependencies and a basic application structure.
+- **`webpack`**: Provides a foundational Webpack project setup. Useful for understanding and customizing build processes from scratch.
 
 ### 3. Additional Dependency Installation
 
-You can select any *additional* npm packages you want to install beyond those provided by the chosen template. Template-specific dependencies (both regular and dev dependencies) will be automatically installed as part of the template application process.
+You can select any _additional_ npm packages you want to install beyond those provided by the chosen template. Template-specific dependencies (both regular and dev dependencies) will be automatically installed as part of the template application process.
 
 **Example:**
 
@@ -92,12 +94,12 @@ Confirm if you want to generate an `INSTRUCTIONS.md` file within your new projec
 
 After successfully running `create-wizard`, your new project directory (`my-awesome-project` in the example above) will contain:
 
-*   **`package.json`**: Fully configured with the project name, merged dependencies (from both template and your selections), and template-defined npm scripts.
-*   **`node_modules/`**: Contains all installed npm dependencies.
-*   **Template-specific files and folders**: The complete file structure provided by the chosen template (e.g., `src/`, `public/`, configuration files).
-*   **`INSTRUCTIONS.md`** (if generated): A markdown file with quick setup and usage instructions.
-*   **`README.md`**: A comprehensive `README.md` file for your new project, including project overview, setup, usage, and contribution guidelines.
-*   **`.git/`** (if Git initialization was selected): The Git repository.
+- **`package.json`**: Fully configured with the project name, merged dependencies (from both template and your selections), and template-defined npm scripts.
+- **`node_modules/`**: Contains all installed npm dependencies.
+- **Template-specific files and folders**: The complete file structure provided by the chosen template (e.g., `src/`, `public/`, configuration files).
+- **`INSTRUCTIONS.md`** (if generated): A markdown file with quick setup and usage instructions.
+- **`README.md`**: A comprehensive `README.md` file for your new project, including project overview, setup, usage, and contribution guidelines.
+- **`.git/`** (if Git initialization was selected): The Git repository.
 
 ## Example Workflow
 
@@ -124,4 +126,4 @@ cd my-react-app
 
 # Start developing!
 npm run dev
-```
+```

docs/contribution.md docs/docs/contribution.mddocs/contribution.md renamed to docs/docs/contribution.md

@@ -1,19 +1,21 @@
-# Contributing to @involvex/create-universe
+<!-- @format -->
 
-We welcome contributions to the `@involvex/create-universe` project! By contributing, you help us make this CLI tool even better for the community.
+# Contributing to @involvex/create-wizard
+
+We welcome contributions to the `@involvex/create-wizard` project! By contributing, you help us make this CLI tool even better for the community.
 
 ## How to Contribute
 
 ### Reporting Bugs
 
 If you find a bug, please open an issue on our GitHub repository. When reporting a bug, please include:
 
-*   A clear and concise description of the bug.
-*   Steps to reproduce the behavior.
-*   Expected behavior.
-*   Actual behavior.
-*   Screenshots or error messages (if applicable).
-*   Your operating system, Node.js version, and `create-universe` version.
+- A clear and concise description of the bug.
+- Steps to reproduce the behavior.
+- Expected behavior.
+- Actual behavior.
+- Screenshots or error messages (if applicable).
+- Your operating system, Node.js version, and `create-universe` version.
 
 ### Suggesting Enhancements
 
@@ -27,18 +29,21 @@ We encourage code contributions! If you'd like to submit code, please follow the
     Go to [https://github.com/involvex/create-universe]https://github.com/involvex/create-wizard and click the "Fork" button.
 
 2.  **Clone your forked repository**:
+
     ```bash
     git clone https://github.com/YOUR_USERNAME/create-universe.git
     cd create-universe
     ```
 
 3.  **Install dependencies**:
+
     ```bash
     npm install
     ```
 
 4.  **Create a new branch**:
     Choose a descriptive name for your branch (e.g., `feature/add-new-template`, `fix/bug-in-git-init`).
+
     ```bash
     git checkout -b feature/your-feature-name
     ```
@@ -48,24 +53,29 @@ We encourage code contributions! If you'd like to submit code, please follow the
 
 6.  **Run tests**:
     Before committing, make sure all existing tests pass and add new tests for your changes if applicable.
+
     ```bash
     npm test
     ```
 
 7.  **Lint and format your code**:
     Ensure your code is properly linted and formatted.
+
     ```bash
     npm run check
     ```
 
 8.  **Commit your changes**:
     Write a clear and concise commit message. We follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+
     ```bash
     git commit -m "feat: add new template for XYZ"
     ```
+
     (Replace `feat` with `fix`, `docs`, `chore`, etc., as appropriate.)
 
 9.  **Push your branch**:
+
     ```bash
     git push origin feature/your-feature-name
     ```
@@ -75,10 +85,10 @@ We encourage code contributions! If you'd like to submit code, please follow the
 
 ## Code Style and Conventions
 
-*   **Linting**: We use ESLint to enforce code quality. Please run `npm run lint` and `npm run lint:fix` before committing.
-*   **Formatting**: We use Prettier for code formatting. Please run `npm run format` before committing.
-*   **Commit Messages**: Follow the Conventional Commits specification.
+- **Linting**: We use ESLint to enforce code quality. Please run `npm run lint` and `npm run lint:fix` before committing.
+- **Formatting**: We use Prettier for code formatting. Please run `npm run format` before committing.
+- **Commit Messages**: Follow the Conventional Commits specification.
 
 ## License
 
-By contributing to `@involvex/create-universe`, you agree that your contributions will be licensed under the project's MIT License.
+By contributing to `@involvex/create-wizard`, you agree that your contributions will be licensed under the project's MIT License.

docs/installation.md docs/docs/installation.mddocs/installation.md renamed to docs/docs/installation.md

@@ -1,12 +1,14 @@
-# Installation Guide for @involvex/create-universe
+<!-- @format -->
 
-This document provides detailed instructions on how to install and set up the `@involvex/create-universe` CLI tool.
+# Installation Guide for @involvex/create-wizard
+
+This document provides detailed instructions on how to install and set up the `@involvex/create-wizard` CLI tool.
 
 ## Prerequisites
 
 Before you can install and use `create-universe`, you need to have Node.js installed on your system.
 
-*   **Node.js**: Version 22.0.0 or higher is required. You can download it from the official Node.js website: [https://nodejs.org/](https://nodejs.org/)
+- **Node.js**: Version 22.0.0 or higher is required. You can download it from the official Node.js website: [https://nodejs.org/](https://nodejs.org/)
 
 To verify your Node.js installation, open your terminal or command prompt and run:
 
@@ -27,7 +29,7 @@ v22.x.x
 The recommended way to install `create-universe` is globally using npm (Node Package Manager). This makes the `create-universe` command available from any directory in your terminal.
 
 ```bash
-npm install -g @involvex/create-universe
+npm install -g @involvex/create-wizard
 ```
 
 After installation, you can verify that the CLI tool is correctly installed by running:
@@ -43,17 +45,20 @@ This should display the installed version of the `create-universe` tool.
 If you plan to contribute to the `create-universe` project or want to run it locally without global installation, follow these steps:
 
 1.  **Clone the repository**:
+
     ```bash
     git clone https://github.com/involvex/create-wizard.git
     cd create-universe
     ```
 
 2.  **Install project dependencies**:
+
     ```bash
     npm install
     ```
 
 3.  **Build the CLI tool**:
+
     ```bash
     npm run build
     ```
@@ -70,11 +75,11 @@ If you plan to contribute to the `create-universe` project or want to run it loc
 
 ## Troubleshooting
 
-*   **`command not found: create-universe`**:
-    *   Ensure Node.js and npm are correctly installed and added to your system's PATH.
-    *   Try reinstalling globally: `npm install -g @involvex/create-universe`.
-    *   On some systems, you might need `sudo npm install -g @involvex/create-universe`.
-*   **Permission errors during global installation**:
-    *   This often indicates that npm doesn't have write permissions to the global installation directory. You can either:
-        *   Use `sudo` (on macOS/Linux): `sudo npm install -g @involvex/create-wizard`.
-        *   Change npm's default directory: Refer to npm's official documentation on "Fixing npm permissions".
+- **`command not found: create-universe`**:
+  - Ensure Node.js and npm are correctly installed and added to your system's PATH.
+  - Try reinstalling globally: `npm install -g @involvex/create-wizard`.
+  - On some systems, you might need `sudo npm install -g @involvex/create-wizard`.
+- **Permission errors during global installation**:
+  - This often indicates that npm doesn't have write permissions to the global installation directory. You can either:
+    - Use `sudo` (on macOS/Linux): `sudo npm install -g @involvex/create-wizard`.
+    - Change npm's default directory: Refer to npm's official documentation on "Fixing npm permissions".

docs/docusaurus.config.js

@@ -0,0 +1,147 @@
+// @ts-check
+// `@type` JSDoc annotations allow editor autocompletion and type checking
+// (when paired with `@ts-check`).
+// There are various equivalent ways to declare your Docusaurus config.
+// See https://docusaurus.io/docs/api/docusaurus-config/
+
+import { themes as prismThemes } from 'prism-react-renderer';
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: '@involvex/create-wizard Documentation',
+  tagline: 'Streamline your JavaScript project setup with ease.',
+  favicon: 'img/favicon.ico',
+
+  // Set the production url of your site here
+  url: 'https://involvex.github.io',
+  // Set the /<baseUrl>/ pathname under which your site is served
+  // For GitHub pages deployment, it is often '/<'projectName'>/'
+  baseUrl: '/create-wizard/',
+
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
+  organizationName: 'involvex', // Usually your GitHub org/user name.
+  projectName: 'create-wizard', // Usually your repo name.
+
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+
+  // Even if you don't use internationalization, you can use this field to set
+  // useful metadata like html lang. For example, if your site is Chinese, you
+  // may want to replace "en" with "zh-Hans".
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          sidebarPath: './sidebars.js',
+          // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
+          editUrl:
+            'https://github.com/involvex/create-wizard/tree/main/docs/',
+        },
+        blog: false, // Disable blog plugin
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      }),
+    ],
+  ],
+
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      // Replace with your project's social card
+      image: 'img/docusaurus-social-card.jpg',
+      navbar: {
+        title: '@involvex/create-wizard',
+        logo: {
+          alt: 'My Project Logo',
+          src: 'img/logo.svg', // You might want to create a custom logo
+        },
+        items: [
+          {
+            type: 'docSidebar',
+            sidebarId: 'tutorialSidebar',
+            position: 'left',
+            label: 'Documentation',
+          },
+          {
+            href: 'https://github.com/involvex/create-wizard',
+            label: 'GitHub',
+            position: 'right',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Docs',
+            items: [
+              {
+                label: 'Installation',
+                to: '/docs/installation',
+              },
+              {
+                label: 'Usage',
+                to: '/docs/usage',
+              },
+              {
+                label: 'Contribution',
+                to: '/docs/contribution',
+              },
+            ],
+          },
+          {
+            title: 'Community',
+            items: [
+              {
+                label: 'Stack Overflow',
+                href: 'https://stackoverflow.com/questions/tagged/docusaurus',
+              },
+              {
+                label: 'Discord',
+                href: 'https://discordapp.com/invite/docusaurus',
+              },
+              {
+                label: 'Twitter',
+                href: 'https://twitter.com/docusaurus',
+              },
+            ],
+          },
+          {
+            title: 'More',
+            items: [
+              {
+                label: 'GitHub',
+                href: 'https://github.com/involvex/create-wizard',
+              },
+            ],
+          },
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} Involvex. Built with Docusaurus.`,
+      },
+      prism: {
+        theme: prismThemes.github,
+        darkTheme: prismThemes.dracula,
+      },
+      algolia: {
+        // The application ID provided by Algolia
+        appId: 'YOUR_APP_ID', // Replace with your Algolia App ID
+        // Public API key: it is safe to commit it
+        apiKey: 'YOUR_SEARCH_API_KEY', // Replace with your Algolia Search API Key
+        indexName: 'YOUR_INDEX_NAME', // Replace with your Algolia Index Name
+        // Optional: path for search page that renders nothing at /search
+        // searchPagePath: 'search',
+      },
+    }),
+};
+
+export default config;