GitPageDocsGitPageDocs

GitPageDocs turns a single config file into a complete, static documentation site: multilingual (en/pt/es), version-aware (/v/:version), themeable and deployable to GitHub Pages with no server. It ships as three npm packages that share one core.

Run the CLI in your repository. It writes a gitpagedocs/ folder with config.json and multilingual markdown you can edit right away.

# one-off, no install
npx @gitpagedocs/cli

# include local theme layouts
npx @gitpagedocs/cli --layoutconfig

# configure GitHub Pages + commit + push
npx @gitpagedocs/cli deploy --owner <you> --repo <repo>

config.json has two top-level sections. site holds the chrome (name, defaultLanguage, theme defaults, header icons, AiChatEnabled, docsAccess). VersionControl lists the documentation versions.

UI text lives next to it: site.languages in config.json switches each language on or off in menu order ({ "languages": { "en": true, "pt": true, "es": false } }; a language set to false is hidden from the selector) and gitpagedocs/langs/<lang>.json holds that language's langmenu (header, search, source viewer, audio player, AI chat, docs-access labels) and translations (notFound, navigation, footer). To add a language, create its file and add "<lang>": true to site.languages.

Each theme is a JSON template (colors, typography, component tokens) turned into CSS variables at runtime. Pick a default with site.ThemeDefault and site.ThemeModeDefault; visitors can switch theme and light/dark mode from the header.

The catalog includes editor-inspired themes (VSCode Light/Dark) plus 25 modern palettes such as Midnight, Neon Noir, Ember, Cobalt, Lagoon, Orchid, Velvet and more.

The docs ship an AI assistant in two surfaces: an in-docs chat drawer (enabled by site.AiChatEnabled) and a dedicated /ai console. Both share one core across 14 providers: OpenAI, Anthropic, Gemini, OpenRouter, Ollama, Azure OpenAI, Mistral, DeepSeek, Cohere, Groq, xAI, Together, Fireworks and Perplexity.

gitpagedocs mcp start runs a Model Context Protocol server over stdio exposing 20 tools (filesystem, AI, doc generation/analysis) and 7 resources for editors and AI agents.

• project://structure
• project://docs
• project://config
• project://repository
• project://readme
• project://ai/providers
• project://ai/models

@gitpagedocs/tools is the core both the CLI and the MCP server build on. It provides the crypto service (AES-256-GCM), the encrypted credential vault, a memory cache with TTL, a redaction-aware logger, and the shared doc-access key scheme.

Set a top-level auth block in a version config (accessKeys, rolesStorageKey, providers) and per-route authorization (accessKeyId, requiredRoles, requireExternalAuth, allowedProviders). A whole documentation can also sit behind a password gate via site.docsAccess.

gitpagedocs deploy generates a GitHub Actions workflow that statically exports the site and publishes it to GitHub Pages on every push to the default branch.