docs.page  by invertase

Instant, agent-ready documentation from GitHub

Created 5 years ago
636 stars

Top 51.4% on SourcePulse

GitHubView on GitHub
1 Expert Loves This Project
Project Summary

<2-3 sentences summarising what the project addresses and solves, the target audience, and the benefit.> docs.page provides instant, zero-configuration documentation sites from any public GitHub branch. It targets developers seeking to serve markdown content for both human readers and AI agents, eliminating the need for complex build pipelines or hosting setup. The primary benefit is rapid deployment and an agent-ready documentation infrastructure.

How It Works

The system serves markdown files directly from a specified GitHub repository branch, transforming them into a modern web interface. Key features include an integrated MCP server and auto-generated llms.txt for AI agent consumption, enabling direct querying of documentation content. It supports MDX for interactive Markdown components and leverages shadcn/ui for customizable styling, all deployed via Git publishing without external build tools or infrastructure management.

Quick Start & Requirements

  • Install/Run: npx @docs.page/cli init
  • Prerequisites: A public GitHub repository containing docs.json and a docs/ directory.
  • Links: Homepage, Documentation, Quickstart, Contribute, Discussions.

Highlighted Details

  • Agent-Ready: Features an MCP server, auto-generated llms.txt, and an optional "Ask AI" (beta) chat interface for LLM querying.
  • Zero-Config Deployment: Utilizes Git publishing, removing the need for build pipelines, hosting configuration, or infrastructure maintenance.
  • Integrated Search & Chat: Offers built-in full-text search (Cmd+K) and embedded AI chat for instant information retrieval.
  • Extensible Markdown: Supports MDX for richer, interactive content components.
  • Version Management: Allows serving any Git branch or tag as a distinct documentation site.

Maintenance & Community

Maintained by Invertase. Community engagement is facilitated via Contribute and Discussions links.

Licensing & Compatibility

The project is open-source, with the specific license detailed in the LICENSE file. No explicit compatibility notes for commercial use or closed-source linking are provided in the README.

Limitations & Caveats

The "Ask AI" feature is noted as beta. While offering zero-configuration, the project's scope might differ from comprehensive static site generators like Docusaurus, as suggested by comparison links.

Health Check
Last Commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
46
Issues (30d)
9
Star History
2 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.