xyd

xyd é um framework de documentação que permite criar sites de documentação profissionais sem precisar lidar com ferramentas complexas. Ele vem com seis temas integrados lindos que você pode usar imediatamente, ou pode personalizar cada parte para combinar com sua marca. O framework gera automaticamente documentação a partir das suas especificações de código OpenAPI, GraphQL, TypeScript e React.

Diferente de outras ferramentas de documentação, xyd inclui tudo o que você precisa desde o início. Você obtém busca de texto completo com sugestões inteligentes, análises integradas para acompanhar como as pessoas usam sua documentação, integração de chat ao vivo e até recursos de testes A/B. O servidor de desenvolvimento inicia instantaneamente com recarga a quente, para que você veja as mudanças imediatamente. Criado por desenvolvedores para desenvolvedores, xyd elimina as partes chatas de fazer documentação para que você possa se concentrar em escrever um ótimo conteúdo.

Começar com o xyd é simples. Aqui estão os passos para criar sua documentação:

• Instale o xyd globalmente usando o comando bun add -g xyd-js ou seu gerenciador de pacotes preferido. Você precisará do Node.js versão 22.12 ou superior instalado no seu computador.

• Execute xyd na pasta do seu projeto para iniciar o servidor de desenvolvimento. Ele inicia instantaneamente com recarga a quente, o que significa que você pode ver suas alterações aparecerem imediatamente sem precisar reiniciar.

• Escolha entre seis temas integrados ou crie seu próprio design personalizado. Cada tema oferece um estilo e layout diferentes para atender às necessidades do seu projeto.

• Escreva sua documentação usando o framework de conteúdo rico que suporta componentes interativos, exemplos de código ao vivo e elementos dinâmicos que tornam seus documentos mais envolventes.

• Para documentação de API, basta apontar o xyd para suas especificações OpenAPI, GraphQL, TypeScript ou React e ele gera automaticamente uma documentação bonita.

• Execute xyd build quando estiver pronto para criar arquivos estáticos para implantação em qualquer serviço de hospedagem.

• Seis belos temas integrados disponíveis

• Documentação automática de API a partir de OpenAPI, GraphQL, TypeScript, React

• Servidor de desenvolvimento com recarga a quente e zero configuração

• Personalização completa de todos os componentes e layouts

• Ecossistema rico de plugins para busca, análise, chat

• Exemplos de código interativos e conteúdo dinâmico

• Suporte integrado para análise e testes A/B

• Funcionalidade de busca por texto completo extremamente rápida

• Open source e completamente gratuito

• Ferramentas de migração de outros frameworks