ryoppippi · ryoppippi · Sep 18, 2025 · Sep 18, 2025 · Sep 18, 2025 · Sep 18, 2025
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -1,13 +1,12 @@
-import { defineConfig } from 'vitepress';
-import * as path from 'node:path';
+import type { DefaultTheme } from 'vitepress';
 import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { cloudflareRedirect } from '@ryoppippi/vite-plugin-cloudflare-redirect';
+import { defineConfig } from 'vitepress';
 import { groupIconMdPlugin, groupIconVitePlugin } from 'vitepress-plugin-group-icons';
 import llmstxt from 'vitepress-plugin-llms';
-import type { DefaultTheme } from 'vitepress';
-import { cloudflareRedirect } from '@ryoppippi/vite-plugin-cloudflare-redirect';
 
-
-const typedocSidebarJson = fs.readFileSync(path.join(import.meta.dirname, '../api/typedoc-sidebar.json'))
+const typedocSidebarJson = fs.readFileSync(path.join(import.meta.dirname, '../api/typedoc-sidebar.json'));
 const typedocSidebar = JSON.parse(typedocSidebarJson.toString()) as DefaultTheme.SidebarItem[];
 
 export default defineConfig({
@@ -150,14 +149,14 @@ export default defineConfig({
 	vite: {
 		plugins: [
 			cloudflareRedirect({
-            mode: "generate",
-            entries: [
-                { from: '/raycast', to: 'https://www.raycast.com/nyatinte/ccusage', status: 302 },
-                { from: '/gh', to: 'https://github.com/ryoppippi/ccusage', status: 302 },
-                { from: '/npm', to: 'https://www.npmjs.com/package/ccusage', status: 302 },
-                { from: '/deepwiki', to: 'https://deepwiki.com/ryoppippi/ccusage', status: 302 },
-            ]
-        }) as any,
+				mode: 'generate',
+				entries: [
+					{ from: '/raycast', to: 'https://www.raycast.com/nyatinte/ccusage', status: 302 },
+					{ from: '/gh', to: 'https://github.com/ryoppippi/ccusage', status: 302 },
+					{ from: '/npm', to: 'https://www.npmjs.com/package/ccusage', status: 302 },
+					{ from: '/deepwiki', to: 'https://deepwiki.com/ryoppippi/ccusage', status: 302 },
+				],
+			}) as any,
 			groupIconVitePlugin(),
 			...llmstxt(),
 		],

diff --git a/docs/CLAUDE.md b/docs/CLAUDE.md
@@ -11,31 +11,38 @@ This directory contains the VitePress-based documentation website for ccusage.
 ## Development Commands
 
 **Documentation Development:**
+
 - `pnpm run dev` - Start development server with API docs generation and schema copy
 - `pnpm run build` - Build documentation site for production
 - `pnpm run preview` - Preview built documentation locally
 - `pnpm run docs:api` - Generate API documentation from TypeScript source
+- `pnpm run lint` - Lint documentation files using ESLint
+- `pnpm run format` - Format and auto-fix documentation files with ESLint
 - `pnpm typecheck` - Type check TypeScript files
 
 **Deployment:**
+
 - `pnpm run deploy` - Deploy to Cloudflare using Wrangler
 
 ## Architecture
 
 **Documentation Structure:**
+
 - `guide/` - User guides and tutorials with screenshots
 - `api/` - Auto-generated API documentation from TypeScript source
 - `public/` - Static assets including screenshots and config schema
 - `.vitepress/` - VitePress configuration and theme customization
 
 **Key Files:**
+
 - `update-api-index.ts` - Script to generate API documentation index
 - `typedoc.config.mjs` - TypeDoc configuration for API docs generation
 - `public/config-schema.json` - JSON schema copied from ccusage package during build
 
 ## Documentation Guidelines
 
 **Screenshot Usage:**
+
 - **Placement**: Always place screenshots immediately after main headings (H1)
 - **Purpose**: Provide immediate visual context before textual explanations
 - **Guides with Screenshots**:
@@ -47,6 +54,7 @@ This directory contains the VitePress-based documentation website for ccusage.
 - **Alt Text**: Always include descriptive alt text for accessibility
 
 **Content Organization:**
+
 - User-facing guides in `guide/` directory
 - Auto-generated API reference in `api/` directory
 - Static assets and schemas in `public/` directory
@@ -61,6 +69,7 @@ This directory contains the VitePress-based documentation website for ccusage.
 ## Dependencies
 
 **Key Dev Dependencies:**
+
 - `vitepress` - Static site generator
 - `typedoc` - API documentation generation
 - `typedoc-plugin-markdown` - Markdown output for TypeDoc
@@ -69,6 +78,7 @@ This directory contains the VitePress-based documentation website for ccusage.
 - `ccusage` - Main package (workspace dependency for API docs)
 
 **VitePress Plugins:**
+
 - `vitepress-plugin-group-icons` - Group icons in navigation
 - `vitepress-plugin-llms` - LLM-specific enhancements
 - `@ryoppippi/vite-plugin-cloudflare-redirect` - Cloudflare redirect handling
@@ -88,6 +98,7 @@ This directory contains the VitePress-based documentation website for ccusage.
 - **Visual First**: Lead with screenshots, then explain with text
 - **Consistency**: Follow established patterns for new documentation pages
 - **Cross-References**: Link between related guides and API documentation
+- **ESLint in Markdown**: For code blocks that should skip ESLint parsing (e.g., containing `...` syntax), add `<!-- eslint-skip -->` before the code block
 
 ## File Organization
 
@@ -99,4 +110,4 @@ docs/
 ├── .vitepress/     # VitePress configuration
 ├── package.json    # Dependencies and scripts
 └── CLAUDE.md       # This file
-```
+```
diff --git a/docs/eslint.config.js b/docs/eslint.config.js
@@ -0,0 +1,14 @@
+import { ryoppippi } from '@ryoppippi/eslint-config';
+
+export default ryoppippi({
+	type: 'lib',
+	svelte: false,
+	markdown: true,
+	ignores: [
+		'.vitepress/dist',
+		'.vitepress/cache',
+		'api/**',
+		'public/**',
+		'update-api-index.ts', // Script file with specific patterns
+	],
+});
diff --git a/docs/guide/cli-options.md b/docs/guide/cli-options.md
@@ -94,6 +94,7 @@ ccusage monthly -z Europe/London
 #### Timezone Effect
 
 The timezone affects how usage is grouped by date. For example, usage at 11 PM UTC on January 1st would appear on:
+
 - **January 1st** when `--timezone UTC`
 - **January 1st** when `--timezone America/New_York` (6 PM EST)
 - **January 2nd** when `--timezone Asia/Tokyo` (8 AM JST next day)
@@ -121,12 +122,14 @@ ccusage daily -l fr-FR
 The locale affects display formatting:
 
 **Date Format:**
+
 - `en-US`: 08/04/2025
 - `en-CA`: 2025-08-04 (ISO format, default)
 - `ja-JP`: 2025/08/04
 - `de-DE`: 04.08.2025
 
 **Time Format:**
+
 - `en-US`: 3:30:00 PM (12-hour)
 - Others: 15:30:00 (24-hour)
 
@@ -322,17 +325,17 @@ LOG_LEVEL=0 ccusage daily --json
 
 Many options have short aliases for convenience:
 
-| Long Option | Short | Description |
-|------------|-------|-------------|
-| `--json` | `-j` | JSON output |
-| `--breakdown` | `-b` | Per-model breakdown |
-| `--offline` | `-O` | Offline mode |
-| `--timezone` | `-z` | Set timezone |
-| `--locale` | `-l` | Set locale |
-| `--instances` | `-i` | Group by project |
-| `--project` | `-p` | Filter project |
-| `--active` | `-a` | Active block only |
-| `--recent` | `-r` | Recent blocks |
+| Long Option   | Short | Description         |
+| ------------- | ----- | ------------------- |
+| `--json`      | `-j`  | JSON output         |
+| `--breakdown` | `-b`  | Per-model breakdown |
+| `--offline`   | `-O`  | Offline mode        |
+| `--timezone`  | `-z`  | Set timezone        |
+| `--locale`    | `-l`  | Set locale          |
+| `--instances` | `-i`  | Group by project    |
+| `--project`   | `-p`  | Filter project      |
+| `--active`    | `-a`  | Active block only   |
+| `--recent`    | `-r`  | Recent blocks       |
 
 ## Related Documentation
 

diff --git a/docs/guide/codex/daily.md b/docs/guide/codex/daily.md
@@ -12,14 +12,14 @@ npx @ccusage/codex@latest daily
 
 ## Options
 
-| Flag | Description |
-| --- | --- |
-| `--since` / `--until` | Filter to a specific date range (YYYYMMDD or YYYY-MM-DD) |
-| `--timezone` | Override timezone used for grouping (defaults to system) |
-| `--locale` | Adjust date formatting locale |
-| `--json` | Emit structured JSON instead of a table |
-| `--offline` / `--no-offline` | Force cached LiteLLM pricing or enable live fetching |
-| `--compact` | Force compact table layout (same columns as a narrow terminal) |
+| Flag                         | Description                                                    |
+| ---------------------------- | -------------------------------------------------------------- |
+| `--since` / `--until`        | Filter to a specific date range (YYYYMMDD or YYYY-MM-DD)       |
+| `--timezone`                 | Override timezone used for grouping (defaults to system)       |
+| `--locale`                   | Adjust date formatting locale                                  |
+| `--json`                     | Emit structured JSON instead of a table                        |
+| `--offline` / `--no-offline` | Force cached LiteLLM pricing or enable live fetching           |
+| `--compact`                  | Force compact table layout (same columns as a narrow terminal) |
 
 The output uses the same responsive table component as ccusage, including compact mode support and per-model token summaries.
 

diff --git a/docs/guide/codex/index.md b/docs/guide/codex/index.md
@@ -31,10 +31,10 @@ The CLI reads Codex session JSONL files located under `CODEX_HOME` (defaults to
 
 ## Environment Variables
 
-| Variable | Description |
-| --- | --- |
+| Variable     | Description                                                  |
+| ------------ | ------------------------------------------------------------ |
 | `CODEX_HOME` | Override the root directory containing Codex session folders |
-| `LOG_LEVEL` | Adjust consola verbosity (0 silent … 5 trace) |
+| `LOG_LEVEL`  | Adjust consola verbosity (0 silent … 5 trace)                |
 
 When Codex emits a model alias (for example `gpt-5-codex`), the CLI automatically resolves it to the canonical LiteLLM pricing entry. No manual override is needed.
 

diff --git a/docs/guide/codex/monthly.md b/docs/guide/codex/monthly.md
@@ -14,13 +14,13 @@ npx @ccusage/codex@latest monthly
 
 ## Options
 
-| Flag | Description |
-| --- | --- |
-| `--since` / `--until` | Filter to a specific date range (YYYYMMDD or YYYY-MM-DD) before aggregating |
-| `--timezone` | Override the timezone used to bucket usage into months |
-| `--locale` | Adjust month label formatting |
-| `--json` | Emit structured JSON instead of a table |
-| `--offline` / `--no-offline` | Force cached LiteLLM pricing or enable live fetching |
-| `--compact` | Force compact table layout (same columns as a narrow terminal) |
+| Flag                         | Description                                                                 |
+| ---------------------------- | --------------------------------------------------------------------------- |
+| `--since` / `--until`        | Filter to a specific date range (YYYYMMDD or YYYY-MM-DD) before aggregating |
+| `--timezone`                 | Override the timezone used to bucket usage into months                      |
+| `--locale`                   | Adjust month label formatting                                               |
+| `--json`                     | Emit structured JSON instead of a table                                     |
+| `--offline` / `--no-offline` | Force cached LiteLLM pricing or enable live fetching                        |
+| `--compact`                  | Force compact table layout (same columns as a narrow terminal)              |
 
 The output uses the same responsive table component as ccusage, including compact mode support, per-model token summaries, and a combined totals row.
diff --git a/docs/guide/codex/session.md b/docs/guide/codex/session.md
@@ -14,14 +14,14 @@ npx @ccusage/codex@latest session
 
 ## Options
 
-| Flag | Description |
-| --- | --- |
-| `--since` / `--until` | Filter sessions by their activity date (YYYYMMDD or YYYY-MM-DD) |
-| `--timezone` | Override the timezone used for date grouping and last-activity display |
-| `--locale` | Adjust locale for table and timestamp formatting |
-| `--json` | Emit structured JSON (`{ sessions: [], totals: {} }`) instead of a table |
-| `--offline` / `--no-offline` | Force cached LiteLLM pricing or enable live fetching |
-| `--compact` | Force compact table layout (same columns as a narrow terminal) |
+| Flag                         | Description                                                              |
+| ---------------------------- | ------------------------------------------------------------------------ |
+| `--since` / `--until`        | Filter sessions by their activity date (YYYYMMDD or YYYY-MM-DD)          |
+| `--timezone`                 | Override the timezone used for date grouping and last-activity display   |
+| `--locale`                   | Adjust locale for table and timestamp formatting                         |
+| `--json`                     | Emit structured JSON (`{ sessions: [], totals: {} }`) instead of a table |
+| `--offline` / `--no-offline` | Force cached LiteLLM pricing or enable live fetching                     |
+| `--compact`                  | Force compact table layout (same columns as a narrow terminal)           |
 
 JSON output includes a `sessions` array with per-model breakdowns, cached token counts, `lastActivity`, and `isFallback` flags for any events that required the legacy `gpt-5` pricing fallback.