create-bunspace 0.1.0 → 0.2.0

package/templates/fumadocs/content-template/en/docs/getting-started/installation.mdx

@@ -0,0 +1,168 @@
+---
+title: Installation
+description: 'Installation and configuration of {{PROJECT_NAME}}'
+---
+
+import { Callout, Steps, Tabs, Tab } from 'fumadocs-ui/components';
+import { Terminal, FileCode } from 'lucide-react';
+
+# Installation
+
+Complete installation guide for {{PROJECT_NAME}}.
+
+## Installation Options
+
+<Tabs items={['Using mks-scaffolder', 'Manual', 'GitHub Clone']}>
+  <Tab value="Using mks-scaffolder">
+    <Steps>
+    ### Create a new project
+
+    ```bash
+    bunx mks-scaffolder create my-project --template fumadocs
+    ```
+
+    Answer the interactive questions:
+    - **Project name**: `my-project`
+    - **Description**: Your project description
+    - **Author**: Your name
+    - **Base path**: `/my-project` (for GitHub Pages)
+
+    ### Enter the directory
+
+    ```bash
+    cd my-project
+    ```
+
+    ### Install dependencies and start
+
+    ```bash
+    bun install
+    bun run dev
+    ```
+
+    </Steps>
+  </Tab>
+
+  <Tab value="Manual">
+    <Steps>
+    ### Create the project
+
+    ```bash
+    mkdir my-project && cd my-project
+    bun init -y
+    ```
+
+    ### Install dependencies
+
+    ```bash
+    bun add next fumadocs-ui fumadocs-mdx next-intl lucide-react
+    bun add -d @types/node @types/react @types/react-dom
+    ```
+
+    ### Copy template files
+
+    Copy the content from `mks-fumadocs-template/` to your project.
+
+    ### Configure .env.local
+
+    ```bash
+    PROJECT_NAME=My Project
+    DESCRIPTION=Description
+    AUTHOR=Your Name
+    BASE_PATH=/my-project
+    ```
+
+    </Steps>
+  </Tab>
+
+  <Tab value="GitHub Clone">
+    <Steps>
+    ### Clone the repository
+
+    ```bash
+    git clone https://github.com/{{GITHUB_REPO}}.git my-project
+    cd my-project
+    ```
+
+    ### Install dependencies
+
+    ```bash
+    bun install
+    ```
+
+    ### Configure the project
+
+    Edit `.env.local` with your values.
+
+    </Steps>
+  </Tab>
+</Tabs>
+
+## Verification
+
+<Callout type="success">
+  To verify everything works correctly, run:
+
+  ```bash
+  bun run build
+  bun run start
+  ```
+
+  You should see the documentation at <code>http://localhost:3000</code>
+</Callout>
+
+## Environment Variables
+
+Create a `.env.local` file in the project root:
+
+```bash
+# Project information
+PROJECT_NAME=My Project
+DESCRIPTION=My project description
+AUTHOR=Your Name
+KEYWORDS=docs,documentation
+
+# Deployment
+BASE_PATH=/my-project
+NEXT_PUBLIC_SITE_URL=https://your-username.github.io/my-project
+
+# i18n
+DEFAULT_LOCALE=en
+NEXT_PUBLIC_SUPPORTED_LOCALES=en,es
+
+# URLs
+TRAILING_SLASH=true
+```
+
+<Callout type="warning">
+  <strong>Important</strong>: The <code>.env.local</code> file should not be committed to git. Make sure it's in your <code>.gitignore</code>.
+</Callout>
+
+## Troubleshooting
+
+### Dependency errors
+
+```bash
+# Clean cache and reinstall
+rm -rf node_modules bun.lockb
+bun install
+```
+
+### Build error
+
+```bash
+# Clean .next and rebuild
+rm -rf .next out
+bun run build
+```
+
+### Port in use
+
+```bash
+# Use a different port
+bun run dev --port 3001
+```
+
+## Next Step
+
+Once installed, see [Quick Start](/en/docs/getting-started/quick-start) to start writing your documentation.

package/templates/fumadocs/content-template/en/docs/getting-started/quick-start.mdx

@@ -0,0 +1,168 @@
+---
+title: Quick Start
+description: 'Get started quickly with {{PROJECT_NAME}}'
+---
+
+import { Callout, Steps } from 'fumadocs-ui/components';
+import { FileEdit, Globe, CheckCircle2 } from 'lucide-react';
+
+# Quick Start
+
+Start writing your documentation in minutes.
+
+<Steps>
+### 1. Copy the template content
+
+The template includes a `content-template/` directory with examples. Copy it to `content/`:
+
+```bash
+cp -r content-template/* content/
+```
+
+### 2. Edit your first pages
+
+Navigate to `content/docs/` and edit the `.mdx` files:
+
+```bash
+# Suggested structure
+content/
+├── docs/
+│   ├── index.mdx              # Main page
+│   └── getting-started/
+│       ├── index.mdx          # Introduction
+│       ├── installation.mdx   # Installation
+│       └── quick-start.mdx    # This page
+└── en/docs/                    # English version
+    └── (same structure)
+```
+
+### 3. Start the server
+
+```bash
+bun run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000).
+
+### 4. Customize configuration
+
+Edit `.env.local` with your information:
+
+```bash
+PROJECT_NAME=My Project
+DESCRIPTION=My amazing documentation
+AUTHOR=Your Name
+BASE_PATH=/my-project
+```
+
+</Steps>
+
+## Writing in MDX
+
+Fumadocs uses **MDX**, which allows you to use React components directly in your markdown.
+
+<Callout type="info">
+  MDX is markdown with superpowers. You can import and use React components.
+</Callout>
+
+### Basic example
+
+```mdx
+---
+title: My Page
+description: Page description
+---
+
+import { Callout } from 'fumadocs-ui/components';
+import { Info } from 'lucide-react';
+
+# Title
+
+Normal markdown content.
+
+<Callout type="info" icon={<Info />}>
+  This is a callout using a React component.
+</Callout>
+```
+
+### Available components
+
+Fumadocs UI includes many components:
+
+- **Callout** - Highlighted notes
+- **Steps** - Numbered steps
+- **Tabs** - Content tabs
+- **FileTree** - File trees
+- **Preview** - Code preview
+
+See [Fumadocs UI Documentation](https://fumadocs.vercel.app/ui) for more.
+
+## Adding a new page
+
+<Steps>
+### 1. Create the file
+
+In `content/docs/` or `content/en/docs/`:
+
+```bash
+# Spanish
+touch content/docs/mi-tema/index.mdx
+
+# English
+touch content/en/docs/my-topic/index.mdx
+```
+
+### 2. Add frontmatter
+
+```mdx
+---
+title: My New Topic
+description: Topic description
+---
+```
+
+### 3. Write the content
+
+```mdx
+# My New Topic
+
+Content here...
+```
+
+### 4. Verify
+
+The browser updates automatically.
+
+</Steps>
+
+## Initial Checklist
+
+<Callout type="success">
+  <CheckCircle2 className="w-4 h-4 inline mr-2" />
+  Installation completed
+</Callout>
+
+<Callout type="success">
+  <CheckCircle2 className="w-4 h-4 inline mr-2" />
+  Development server running
+</Callout>
+
+<Callout type="success">
+  <CheckCircle2 className="w-4 h-4 inline mr-2" />
+  First page edited
+</Callout>
+
+<Callout type="success">
+  <CheckCircle2 className="w-4 h-4 inline mr-2" />
+  Configuration customized
+</Callout>
+
+## Next Steps
+
+- **[Features](/en/docs/features)** - Discover more components
+- **[Configuration](/en/docs/configuration)** - Customize your site
+- **[Deployment](/en/docs/deployment)** - Publish your documentation
+
+<Callout type="tip">
+  <strong>Tip</strong>: Use the files in <code>content-template/</code> as reference and then delete them when you've created your own content.
+</Callout>

package/templates/fumadocs/content-template/en/docs/index.mdx

@@ -0,0 +1,69 @@
+---
+title: Welcome
+description: 'Welcome to {{PROJECT_NAME}} - {{DESCRIPTION}}'
+---
+
+import { Callout, Steps } from 'fumadocs-ui/components';
+import { FileCode, Terminal } from 'lucide-react';
+
+# Welcome to {{PROJECT_NAME}}
+
+<Callout type="info">
+  This is a Fumadocs template. Replace this content with your own documentation.
+</Callout>
+
+## Features
+
+This template includes:
+
+- **Bilingual support** - Spanish and English ready to use
+- **Integrated search** - Instant content search
+- **Dark/light theme** - Automatic switching based on system preference
+- **Full MDX** - Use React components in your markdown
+- **GitHub Pages ready** - Configured for static deployment
+
+## Getting Started
+
+<Steps>
+### Installation
+
+```bash
+# Copy content-template/ content to content/
+cp -r content-template/* content/
+```
+
+### Development
+
+```bash
+bun install
+bun run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) to view your documentation.
+
+### Build
+
+```bash
+bun run build
+```
+
+Static files are generated in `out/`.
+
+## Configuration
+
+Edit environment variables in `.env.local`:
+
+```bash
+PROJECT_NAME=My Project
+DESCRIPTION=Description of my project
+AUTHOR=Your Name
+BASE_PATH=/my-project
+```
+
+<Callout type="warning">
+  Remember to configure <code>BASE_PATH</code> if deploying to GitHub Pages with a custom repository name.
+</Callout>
+
+## Next Step
+
+See the [Introduction](/en/docs/getting-started) section for more details.

package/templates/fumadocs/messages/en.json

@@ -0,0 +1,14 @@
+{
+  "nav": {
+    "gettingStarted": "Getting Started",
+    "coreConcepts": "Core Concepts",
+    "libraryReference": "Library Reference",
+    "cliReference": "CLI Reference",
+    "guides": "Guides"
+  },
+  "actions": {
+    "copyMarkdown": "Copy as Markdown",
+    "openMarkdown": "Open as Markdown",
+    "copied": "Copied!"
+  }
+}

package/templates/fumadocs/messages/es.json

@@ -0,0 +1,14 @@
+{
+  "nav": {
+    "gettingStarted": "Introducción",
+    "coreConcepts": "Conceptos Clave",
+    "libraryReference": "Referencia de Biblioteca",
+    "cliReference": "Referencia de CLI",
+    "guides": "Guías"
+  },
+  "actions": {
+    "copyMarkdown": "Copiar como Markdown",
+    "openMarkdown": "Abrir como Markdown",
+    "copied": "¡Copiado!"
+  }
+}

package/templates/fumadocs/next.config.mjs

@@ -0,0 +1,35 @@
+import { createMDX } from 'fumadocs-mdx/next';
+
+const withMDX = createMDX();
+
+/**
+ * Base path for deployment (e.g., '/repo-name' for GitHub Pages).
+ * Leave empty for root domain deployment.
+ */
+const basePath = process.env.BASE_PATH || '';
+
+/**
+ * Next.js configuration for Fumadocs template.
+ *
+ * Uses environment variables to support flexible deployment options:
+ * - BASE_PATH: For GitHub Pages or subdirectory deployment
+ * - TRAILING_SLASH: Enable/disable trailing slash URLs
+ *
+ * @see {@link https://nextjs.org/docs/app/api-reference/next-config-js Next.js Config}
+ * @type {import('next').NextConfig}
+ */
+const config = {
+  reactStrictMode: true,
+
+  // Deployment configuration
+  basePath,
+  output: 'export',
+  images: {
+    unoptimized: true,
+  },
+
+  // URL configuration
+  trailingSlash: process.env.TRAILING_SLASH === 'true' || basePath !== '',
+};
+
+export default withMDX(config);

package/templates/fumadocs/oxlint.json

@@ -0,0 +1,14 @@
+{
+  "categories": {
+    "correctness": "warn",
+    "suspicious": "warn",
+    "perf": "warn",
+    "style": "warn",
+    "restriction": "off"
+  },
+  "env": {
+    "node": true,
+    "es2021": true
+  },
+  "ignore": ["node_modules", "dist", "build", ".turbo", "coverage"]
+}

package/templates/fumadocs/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "telegram-bot-manager-docs",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "build": "next build",
+    "dev": "next dev",
+    "start": "next start",
+    "types:check": "fumadocs-mdx && next typegen && tsc --noEmit",
+    "postinstall": "fumadocs-mdx",
+    "lint": "biome check",
+    "format": "biome format --write"
+  },
+  "dependencies": {
+    "fumadocs-core": "16.4.4",
+    "fumadocs-mdx": "14.2.4",
+    "fumadocs-ui": "16.4.4",
+    "lucide-react": "^0.562.0",
+    "next": "16.1.1",
+    "next-intl": "^4.7.0",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3"
+  },
+  "devDependencies": {
+    "@tailwindcss/postcss": "^4.1.18",
+    "@types/mdx": "^2.0.13",
+    "@types/node": "^24.10.2",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "postcss": "^8.5.6",
+    "tailwindcss": "^4.1.18",
+    "typescript": "^5.9.3",
+    "@biomejs/biome": "^2.3.11"
+  }
+}

package/templates/fumadocs/postcss.config.mjs

@@ -0,0 +1,5 @@
+export default {
+  plugins: {
+    '@tailwindcss/postcss': {},
+  },
+};

package/templates/fumadocs/source.config.ts

@@ -0,0 +1,31 @@
+import { defineConfig, defineDocs, frontmatterSchema, metaSchema } from 'fumadocs-mdx/config';
+
+export const docs = defineDocs({
+  dir: 'content/docs',
+  docs: {
+    schema: frontmatterSchema,
+    postprocess: {
+      includeProcessedMarkdown: true,
+    },
+  },
+  meta: {
+    schema: metaSchema,
+  },
+});
+
+export const docsEn = defineDocs({
+  dir: 'content/en/docs',
+  docs: {
+    schema: frontmatterSchema,
+    postprocess: {
+      includeProcessedMarkdown: true,
+    },
+  },
+  meta: {
+    schema: metaSchema,
+  },
+});
+
+export default defineConfig({
+  mdxOptions: {},
+});

package/templates/fumadocs/src/app/(home)/layout.tsx

@@ -0,0 +1,6 @@
+import { HomeLayout } from 'fumadocs-ui/layouts/home';
+import { baseOptions } from '@/lib/layout.shared';
+
+export default function Layout({ children }: LayoutProps<'/'>) {
+  return <HomeLayout {...baseOptions()}>{children}</HomeLayout>;
+}