Aria Docs

Ariadocs - Modelo de Documentação

Esse modelo de documentação repleto de recursos, construído com o Next.js, oferece um design elegante e responsivo, perfeito para todas as suas necessidades de documentação do projeto.

Aqui estão todas as versões do modelo Ariadocs, cada uma criada para casos de uso específicos:

• DOCs avançados: um modelo abrangente que oferece recursos extensos para necessidades aprofundadas de documentação. Perfeito para projetos maiores que exigem explicações detalhadas e configurações avançadas.
  Explore os documentos avançados

• Versão Lite: um modelo simplificado e sem frescuras, perfeito para necessidades diretas de documentação.
  Explore a versão Lite

• Versão com versão: uma opção poderosa para projetos que exigem rastreamento histórico de documentação. Gerencie várias versões de seus documentos sem esforço.
  Confira o recurso de versão

• Versão de suporte i18n (WIP): projetada para o público internacional, esta versão oferecerá suporte multilíngue abrangente.
  Visualize o suporte i18N

Início rápido

Você pode criar um novo projeto Ariadocs usando o comando:

 npx create-aria-doc <project-directory>

Saída esperada

Quando você executa a CLI, você pode esperar uma saída semelhante a isso:

 Creating a new Ariadocs project in /path/to/your/project from the master branch...
Cloning Master (Full Documentation)...
Ariadocs project successfully created in /path/to/your/project!

Next steps:
1. Navigate to your project directory:
   cd <project-directory>
2. Install dependencies:
   // To support React 19, package maintainers will need to test and update their packages to include React 19 as a peer dependency. This is already in progress.
   npm install --force 
3. Start the development server:
   npm run dev

Começando

Primeiro, execute o servidor de desenvolvimento:

 npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Implantar no vercel

A maneira mais fácil de implantar seu aplicativo Next.js é usar a plataforma Vercel dos criadores do Next.JS.

Confira nossa documentação de implantação do Next.js para obter mais detalhes.

Principais recursos

Recurso	Descrição
Suporte MDX	Escreva documentação interativa com o MDX.
Páginas aninhadas	Organize o conteúdo em uma estrutura hierárquica aninhada.
Seção do blog	Inclua uma seção de blog dedicada.
Índice	TOC gerado automaticamente para facilitar a navegação.
Paginação	Divida o conteúdo em várias páginas.
Destaque da sintaxe	Destaque o código para uma melhor legibilidade.
Código de destaque da linha e títulos	Destaque linhas específicas com títulos descritivos.
Blocos de código interativo	Exibição de código específica e interativa do idioma.
Componentes personalizados	Incorporar componentes personalizados e reutilizáveis ​​em seus documentos.
Modo claro e escuro	Alternar entre temas claros e escuros.
Funcionalidade de pesquisa	Encontre rapidamente o conteúdo com uma pesquisa interna.
Switcher de código	Alterne entre linguagens ou variações de código.
Cópia de código	Copie os blocos de código com um único clique.
TOC Observer Destaque	Destaque seções ativas no TOC enquanto você rola.
Geração estática do local	Gere um site estático e de alto desempenho.
SEO-otimizado	Estruturado para a indexação ideal do mecanismo de pesquisa.

Temas adicionais