Faker Studio

Appearance

CLAUDE.md ​

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview ​

VitePress documentation site for Faker Studio. Covers both Faker Studio Lite (free) and Faker Studio Premium in a single doc set — Premium-only pages/sections are marked with a "Premium" label rather than kept in a separate doc set.

Stack: VitePress 1.6.4, Markdown Hosting: Netlify (docs.fakerstudio.com) — new public site, see Netlify Config below Node: 18

Build & Dev Commands ​

bash
npm run docs:dev               # Local dev server with hot-reload (port 5173)
npm run docs:build             # Production build → .vitepress/dist/
npm run docs:preview           # Preview production build

Design ​

Custom VitePress theme with Faker Studio brand colors. Dark mode by default.

Theme files:

  • .vitepress/theme/index.ts — Imports DefaultTheme + custom CSS
  • .vitepress/theme/style.css — Brand color overrides:
    • --vp-c-brand-1: #44CEFF (cyan)
    • Hero gradient: linear-gradient(135deg, #44CEFF, #F200FF) (cyan → magenta)
    • Dark mode variants with slightly brighter values
  • .vitepress/config.mjs — appearance: 'dark' (dark mode default)

Content Structure ​

index.md                       # Home page (hero + feature cards)
changelog.md                   # Version changelog
privacy.md                     # Privacy & data transparency (all external data flows)
guide/                         # Getting started & configuration (5 pages)
├── getting-started.md         # Overview, requirements, key features
├── installation.md            # Install methods, license activation
├── quick-start.md             # First steps tutorial
├── settings.md                # General plugin settings
└── languages.md               # 13 supported locales
features/                      # Feature documentation (11 pages)
├── post-generation.md
├── taxonomy-generation.md
├── user-generation.md
├── templates.md               # Template system (tabbed editor)
├── content-variation.md       # Variation profiles
├── custom-fields.md           # ACF/native field detection
├── ai-detection.md            # AI providers, setup, token costs, Hive
├── images.md                  # Image providers (Picsum, Placeholder)
├── field-detection.md         # 2-tier detection (pattern + AI)
├── history.md                 # Tracking & cleanup
└── bulk-operations.md         # Batch generation, automation
api/                           # REST API reference (6 pages)
├── endpoints.md               # Overview, auth, error codes
├── generation.md              # POST endpoints for content creation
├── templates.md               # Template CRUD
├── information.md             # GET endpoints for CPTs, taxonomies, fields
├── settings.md                # Settings GET/POST
└── history.md                 # History & cleanup endpoints

24 documentation pages total across 3 sections + 2 standalone pages.

Configured in .vitepress/config.mjs. Three sidebars map to guide/, features/, api/ paths. Top nav: Guide | Features | API | Privacy | fakerstudio.com | version dropdown (changelog).

Adding Documentation ​

  1. Create .md file in the appropriate directory (guide/, features/, or api/)
  2. Add the page to the sidebar config in .vitepress/config.mjs
  3. Use VitePress callout blocks: ::: tip, ::: warning, ::: danger, ::: info
  4. Cross-link with relative markdown paths (e.g., [Templates](/features/templates))

Deployment ​

New Netlify site created 2026-08-12, replacing the old docs.fakerstudio.com site (site ID 6a39532e-1377-41c9-af77-6684bdc8908a, which was auth-gated and offline — left untouched, not reused). This is now a public site with no auth gate and no noindex header.

Manual deploy (no GitHub auto-deploy configured yet — see below):

bash
npx netlify-cli deploy --prod --dir=.vitepress/dist

Netlify Config ​

  • Site ID: 8313a999-da80-4822-877e-4a69b6f7bda6
  • Site name: faker-studio-docs (default domain faker-studio-docs.netlify.app)
  • Custom domain: docs.fakerstudio.com — DNS live and confirmed working (Netlify DNS zone for fakerstudio.com).
  • Build command: npm run docs:build
  • Publish dir: .vitepress/dist
  • Node 18
  • SPA fallback redirect rule in netlify.toml
  • Security headers: X-Frame-Options DENY, X-XSS-Protection, X-Content-Type-Options, Referrer-Policy
  • SEO: indexable (index, follow), no auth gate — this is a public site
  • Not yet linked to GitHub for auto-deploy on push. To enable: Netlify dashboard → this site → Project configuration → Build & deploy → Link repository (emmgeede/faker-studio-docs, branch main). Until then, deploys must be triggered manually with the command above.

All repos renamed 2026-08-15 (WPfaker → Faker Studio) and live as siblings under /home/mg/ownCloud/30-39-Business/31-Projects/31.11-Faker-Studio/:

  • Faker Studio Premium — repo root (31.11-Faker-Studio/), github.com/emmgeede/faker-studio (private)
  • Faker Studio Lite (31.11-Faker-Studio/faker-studio-lite/) — Free WordPress.org plugin, this doc site covers both Lite and Premium, github.com/emmgeede/faker-studio-lite
  • Faker Studio Website (31.11-Faker-Studio/faker-studio-website/) — github.com/emmgeede/faker-studio-website, live on fakerstudio.com. faker-studio-lite-website (formerly wpfaker-lite-website) is a superseded predecessor, likely safe to archive.
  • Faker Studio API (31.11-Faker-Studio/faker-studio-api/) — github.com/emmgeede/faker-studio-api, Go backend for license management, not yet deployed to its target server (AlphaVPS 164.5.250.19)