openFetch documentation

Multilingual documentation for @hamdymohamedak/openfetch (fetch-only HTTP client: interceptors, middleware, retry, memory cache, RSC-friendly).

• Library (GitHub): github.com/openfetch-js/OpenFetch
• npm package: npmjs.com/package/@hamdymohamedak/openfetch

Local package source (optional): ../openFetch if you clone the monorepo sibling in this workspace.

Documentation website (VitePress)

This folder is a VitePress site.

• Default language: English at / (overview, guides, API reference pages).
• Language hub: /languages/ — links to every locale.
• Navbar: Guide (getting started) and Languages; the globe icon (desktop) switches locale while keeping the same page when translations exist (i18nRouting).

Commands

cd openFetchDocs
npm install
npm run dev      # local dev server (default http://localhost:5173)
npm run build    # static output → .vitepress/dist
npm run preview  # serve the production build locally

Deploying the static site

After npm run build, upload .vitepress/dist to any static host (Netlify, Vercel, GitHub Pages, S3, etc.).

GitHub Pages URL depends on who owns the repo (same base: /openfetch-docs/ in both cases):

• openfetch-js.github.io/openfetch-docs/
• hamdymohamedak.github.io/openfetch-docs/

base is /openfetch-docs/ in .vitepress/config.mts. For local dev open http://localhost:5173/openfetch-docs/ (VitePress applies base there too).

Unstyled site or raw <ComparisonMatrix /> in the page?

That means GitHub Pages is serving Jekyll from a branch, not the VitePress artifact from Actions.

1. Open View Page Source on the live URL. If you see
   <meta name="generator" content="Jekyll v3.10.0" />
   (and a single assets/css/style.css from GitHub’s theme), this repo is not deployed via the workflow below.

Fix (required once per repo):

1. Settings → Pages → Build and deployment.
2. Source: select GitHub Actions (not “Deploy from a branch”).
3. Run the workflow: push to main, or in Actions → Deploy docs → Run workflow.

The workflow .github/workflows/deploy-docs.yml uploads .vitepress/dist. After a successful run, a new deployment appears under Settings → Pages (deployed by github-pages).

The build output also includes public/.nojekyll in dist so static assets are not processed as Jekyll if you ever publish that folder manually.

If you move hosting to the domain root, change base to "/".

Locales

Path prefix	Language	Notes
/	English (default)	Full guide set including HTTP methods & React/Vue
/ar/	Arabic (العربية)	RTL · full parity with English sidebar
/es/	Spanish
/fa/	Persian (Farsi)	RTL
/fr/	French
/hi/	Hindi
/it/	Italian
/ja/	Japanese
/kr/	Korean	HTML lang is ko
/ku/	Kurdish

Source layout (English at repo root)

1. index.md — Overview
2. getting-started.md — Install, default client, createClient, middleware
3. http-methods.md — GET, POST, PUT, PATCH, DELETE, request(), bodies & params
4. framework-guides.md — React, RSC, Vue 3, SSR notes
5. configuration.md — OpenFetchConfig, merge rules, unwrapResponse
6. interceptors-middleware.md — Interceptors, use(), ordering
7. retry-cache.md — Retry middleware, memory cache, SWR
8. errors-security.md — OpenFetchError, toShape, assertSafeHttpUrl
9. languages/index.md — Landing page listing all locales

Translated locales live under ar/, es/, etc. (same filenames where translated).

LLM / agent files

• public/llms.txt — Copied to site root as /llms.txt when built (concise API + doc map).
• skills.md — Repo-only companion for AI tools (excluded from VitePress pages via srcExclude).

Package version

The docs site reads the displayed version from .vitepress/openfetch-version.ts (single source of truth for pages, hero “Ask ChatGPT / Claude” links, and generated public/llms.txt). Bump that file when you cut a release. For runtime behavior details and file-level architecture, see docs/PROJECT_FLOW.md in the library repository.