Skip to content

index.mdx

Latest commit

 

History

History
189 lines (159 loc) · 6.02 KB

index.mdx

File metadata and controls

189 lines (159 loc) · 6.02 KB
title DevDoc
description Beautiful documentation powered by AI agents
mode wide
hideHeader true
{/* ASCII Art Logo - inherits text color from Hero variant */} 
{`██████╗ ███████╗██╗   ██╗██████╗  ██████╗  ██████╗
██╔══██╗██╔════╝██║   ██║██╔══██╗██╔═══██╗██╔════╝
██║  ██║█████╗  ██║   ██║██║  ██║██║   ██║██║     
██║  ██║██╔══╝  ╚██╗ ██╔╝██║  ██║██║   ██║██║     
██████╔╝███████╗ ╚████╔╝ ██████╔╝╚██████╔╝╚██████╗
╚═════╝ ╚══════╝  ╚═══╝  ╚═════╝  ╚═════╝  ╚═════╝`}
<Tagline variant="muted" tracking="widest">
  DEVELOPER DOCUMENTATION PLATFORM
</Tagline>

<Headline size="xl">
  Beautiful docs in minutes, not days.
</Headline>

<Description size="lg" maxWidth="lg">
  DevDoc helps you create stunning documentation powered by AI agents. 
  Bootstrap from your codebase, search with agentic intelligence, deploy with one command.
</Description>

<Spacer size="md" />

<CommandBox command="npx @brainfish-ai/devdoc create my-docs" />

<Spacer size="sm" />

<div className="not-prose flex flex-wrap gap-4 justify-center">
  <ButtonLink href="#guides/page/quickstart" variant="primary" size="md" icon="arrow-right">
    Get Started
  </ButtonLink>
  <ButtonLink href="https://github.com/brainfish-ai/devdoc" variant="outline" size="md" icon="github-logo" iconPosition="left">
    View on GitHub
  </ButtonLink>
</div>
WHY DEVDOC Everything you need for great docs Bootstrap docs from your codebase, migrate from other platforms, and keep documentation in sync with AI-powered automation. 
<FeatureItem title="Agentic Search">
  Not just search — an intelligent agent that understands context, 
  executes code in a sandbox, and delivers precise answers.
</FeatureItem>

<FeatureItem title="Fast Setup">
  Deploy your docs in under 5 minutes with a single command. 
  No complex configuration required.
</FeatureItem>

<FeatureItem title="API Playground">
  Postman/Hoppscotch-like API client built into your docs. 
  Test endpoints directly from your OpenAPI specification.
</FeatureItem>

<FeatureItem title="GraphQL Playground">
  Built-in GraphQL explorer with query execution 
  and schema documentation.
</FeatureItem>

<FeatureItem title="Developer First">
  Write in MDX, deploy from CLI, integrate with your 
  CI/CD pipeline seamlessly.
</FeatureItem>
GET STARTED Three steps to launch
```bash npx @brainfish-ai/devdoc create my-docs cd my-docs ``` Choose from **basic**, **openapi**, or **graphql** templates. 
  <Step title="Preview locally">
    ```bash
    npm run dev
    ```
    Make changes and see them instantly with hot reload.
  </Step>
  
  <Step title="Deploy">
    ```bash
    npm run deploy
    ```
    Your docs are live at `https://my-docs-xxxxx.devdoc.sh`
  </Step>
</Steps>
LIVE DEMOS See DevDoc in action Explore our template demos to see what you can build. Simple documentation site with guides and pages. REST API documentation with interactive playground. GraphQL API explorer with query execution.
Ready to build better docs? Get started in minutes. No credit card required. 
<Spacer size="md" />

<div className="not-prose flex flex-wrap gap-4 justify-center">
  <ButtonLink href="#guides/page/quickstart" variant="primary" size="md" icon="arrow-right">
    Start Building
  </ButtonLink>
  <ButtonLink href="#guides/page/cli/overview" variant="outline" size="md" icon="terminal" iconPosition="left">
    CLI Reference
  </ButtonLink>
</div>