Repolode
Enviar
livesession

livesession/xyd

Um framework de documentação em TypeScript que cria sites a partir de Markdown/MDX e gera documentação de APIs com OpenAPI e GraphQL.

Alternativa open source a:Readme.comGitBook

Ver no GitHubSite
Estrelas
115
Forks
9
Issues abertas
36
Último commit
há 8 dias

O que é?

xyd é um framework de documentação feito com TypeScript e React. Ele transforma conteúdo em Markdown e MDX em um site de documentação e inclui um servidor de desenvolvimento com hot reload, que funciona sem configuração, além de um comando para gerar arquivos estáticos para publicação.

Seu diferencial é o suporte nativo a especificações de API. Ele gera documentação a partir de schemas OpenAPI e GraphQL e também oferece geração de SDKs com base nessas especificações. O projeto inclui temas integrados, busca em texto completo e integrações com ferramentas de analytics, testes A/B e chat ao vivo. Além disso, os componentes podem ser estendidos ou substituídos.

O projeto usa a licença MIT e requer Node 22.12 ou posterior. Ele inclui uma ferramenta de migração para facilitar a mudança de outros frameworks de documentação.

Recursos principais

  • 01Gera documentação a partir de conteúdo em Markdown e MDX
  • 02Cria páginas de referência de API com base em especificações OpenAPI e GraphQL
  • 03Oferece geração de SDKs a partir de especificações de API
  • 04Inclui temas integrados e busca em texto completo
  • 05Oferece integrações com ferramentas de analytics, testes A/B e chat ao vivo
  • 06Permite personalizar componentes e layouts

Casos de uso

  • Publicar a documentação de um produto para uma aplicação web
  • Documentar uma API REST ou GraphQL com páginas de referência geradas automaticamente
  • Criar um portal para desenvolvedores que distribui SDKs junto com a documentação da API
  • Migrar um site de documentação existente de outro framework

Início rápido

  1. 1

    Confirme se o Node 22.12 ou uma versão mais recente está instalado

  2. 2

    Instale o xyd globalmente com bun

    bun add -g xyd-js
  3. 3

    Inicie um servidor de desenvolvimento

    xyd
  4. 4

    Gere os arquivos estáticos da documentação

    xyd build

Antes de usar

  • É necessário ter o Node 22.12 ou uma versão mais recente.

Em coleções

APIs GraphQL e clientes de APIGeradores de sites estáticos e ferramentas de documentação

Tópicos

#docs#documentation#markdown#mdx#openapi#graphql#api-docs#react#api-explorer#docs-generator

Perguntas frequentes

O que é xyd?
Um framework de documentação em TypeScript que cria sites a partir de Markdown/MDX e gera documentação de APIs com OpenAPI e GraphQL. xyd é um framework de documentação feito com TypeScript e React. Ele transforma conteúdo em Markdown e MDX em um site de documentação e inclui um servidor de desenvolvimento com hot reload, que funciona sem configuração, além de um comando para gerar arquivos estáticos para publicação.
xyd é gratuito? Qual é a licença?
xyd é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
xyd ainda é mantido?
Manutenção ativa. O último commit de xyd foi em 29 de out. de 2026.
Para que posso usar xyd?
Publicar a documentação de um produto para uma aplicação web Documentar uma API REST ou GraphQL com páginas de referência geradas automaticamente Criar um portal para desenvolvedores que distribui SDKs junto com a documentação da API Migrar um site de documentação existente de outro framework
Como instalar xyd?
Confirme se o Node 22.12 ou uma versão mais recente está instalado Instale o xyd globalmente com bun: bun add -g xyd-js Inicie um servidor de desenvolvimento: xyd Gere os arquivos estáticos da documentação: xyd build
Onde consigo xyd?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/livesession/xyd

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados