Add comprehensive VitePress documentation site #22
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces a complete documentation site for the oauth-callback library using VitePress. The documentation provides comprehensive guides, API references, and examples to help developers integrate OAuth authentication into their CLI tools, desktop applications, and MCP clients.
What's Included
Documentation Structure
API Reference
Core Functions
getAuthCode- Complete reference for OAuth authorization code capturebrowserAuth- MCP SDK-compatible OAuth provider documentationStorage Providers
inMemoryStore- Ephemeral token storagefileStore- Persistent file-based storageError Handling
OAuthErrorclass documentationTypeScript Types
Examples
Features
Changes Made
Testing
To test the documentation locally:
The documentation is available at http://localhost:5173 when running the dev server.
Deployment
The documentation is configured for GitHub Pages deployment at
/oauth-callback/base path. After merging, run:Screenshots
The documentation includes: