cnkang/nginx-markdown-for-agents

O que nginx-markdown-for-agents faz?

Módulo NGINX auto-hospedável que serve Markdown para agentes de IA via negociação de conteúdo HTTP (Accept: text/markdown), alimentado por um conversor Rust.

Visão Geral

Este módulo NGINX permite que suas páginas web sirvam conteúdo Markdown diretamente para agentes de IA. Quando um agente envia uma requisição com o cabeçalho Accept: text/markdown, o módulo converte o HTML da resposta em Markdown usando um conversor Rust eficiente.

Como Funciona

1. O agente de IA (ex: Claude Code, Cursor) faz uma requisição HTTP com cabeçalho Accept: text/markdown.
2. O NGINX, com o módulo instalado, intercepta a requisição.
3. O conversor Rust converte o HTML da página em Markdown limpo.
4. O agente recebe o Markdown, facilitando a extração de informações ou uso como contexto.

Pré-requisitos

• NGINX (versão 1.18 ou superior)
• Rust toolchain (para compilar o conversor)
• Acesso root ou permissões de administrador no servidor

Instalação

1. Clone o repositório:

git clone https://github.com/cnkang/nginx-markdown-for-agents.git

2. Compile o módulo:

make build

3. Copie o módulo para o diretório de módulos do NGINX:

sudo cp target/release/libnginx_markdown.so /etc/nginx/modules/

4. Configure o NGINX para carregar o módulo:

load_module modules/libnginx_markdown.so;

Configuração

No bloco server ou location, adicione:

location / {
    markdown on;
    markdown_content_type text/markdown;
}

Para servir apenas Markdown para agentes específicos:

location /docs {
    markdown on;
    markdown_content_type text/markdown;
    markdown_agent_header "User-Agent" "*Claude* *Cursor* *Codex*";
}

Variáveis de Ambiente

• MARKDOWN_CACHE_SIZE: Tamanho do cache de conversão (padrão: 1000)
• MARKDOWN_TIMEOUT: Timeout de conversão em milissegundos (padrão: 5000)

Uso

Após configurar, agentes de IA podem acessar suas páginas:

curl -H "Accept: text/markdown" https://seusite.com/docs/api

Contribuição

Contribuições são bem-vindas! Envie pull requests para o repositório oficial.

Licença

MIT