DocsConvenções e conceitos

Glossário

As palavras que esses documentos usam, uma linha cada, em ordem alfabética. Um termo que precisa de mais do que uma linha tem uma página: siga o link. Para saber como as noções se encaixam, leia Conceitos básicos.

Termos

Termo Em uma linha
Ação uma função Python marcada como @Action, servida como POST e chamável pelo cliente (ações)
ASGI a interface Uvicorn fala, implementada por FastAPI e Starlette
Modo cliente useCSR = True: os arquivos do framework são as rotas e o navegador navega (modos)
Componente um bloco de construção de UI reutilizável usado para compor uma visualização (visualizações)
CSR renderização do lado do cliente: o navegador renderiza páginas após o primeiro documento (CSR)
Dependência uma função FastAPI é executada antes de um manipulador, por rota ou por pasta (dependências)
Shell do documento o <html>, <head> e <body> em torno de uma página, de propriedade do layout mais próximo ou de Nexy (layouts)
Endpoint a combinação única de uma URL e um método HTTP (visualizações)
Roteamento baseado em arquivo FBR : um arquivo em src/routes/ é uma rota (roteamento)
Frontmatter o bloco Python entre as duas --- linhas de um arquivo .nexy ou .md (arquivos .nexy)
Guarde uma dependência que recusa uma solicitação aumentando HTTPException (guardas)
Handler uma função Python que lida com uma solicitação HTTP para um método específico (visualizações)
HMR substituição de módulo a quente: o servidor de desenvolvimento troca os módulos que foram alterados, sem uma recarga completa (frontend)
Hidratação o navegador anexando uma estrutura ao HTML o servidor já enviou (ilhas)
Ilha um componente cliente montado dentro de uma página renderizada pelo servidor (ilhas)
ISR regeneração estática incremental: uma página em cache por caminho, atualizada em segundo plano (ISR)
Layout um arquivo layout.* que agrupa as páginas abaixo de sua pasta (layouts)
Roteador modular rotas declaradas com @Module e @Controller em src/apps/ (modular)
Página um recurso endereçável por URL definido por um arquivo em src/routes/ (visualizações)
Pré-busca carregando a página atrás de um link antes que o leitor clique nele (links)
Props os valores que um pai passa para um componente (arquivos .nexy)
Revalidar o número de segundos após os quais uma página ISR é reconstruída em segundo plano (ISR)
Rota um padrão de URL, produzido pelo caminho de um arquivo de rota (roteamento)
Grupo de rotas uma pasta entre parênteses que agrupa rotas sem adicionar um segmento (rotas dinâmicas)
Manipulador de rota a GET, POST,… função de um arquivo de rota .py (manipuladores)
Modo servidor useCSR = False, o padrão: o servidor renderiza .nexy e .md páginas (modos)
Habilidade uma pasta com um SKILL.md que ensina ao agente de codificação uma parte do Nexy (agentes de codificação)
SSG geração de sites estáticos; não é um modo Nexy: o HTML construído antecipadamente é sempre lido pelo servidor (renderização)
SSR renderização do lado do servidor: o servidor renderiza cada página para sua solicitação e é o padrão (SSR)
Veja o processo de produção do corpo de resposta para uma página (visualizações)

Arquivos e pastas

Nome Em uma linha
__nexy__/ saída gerada: páginas compiladas, a entrada do cliente e o cliente de ação; nunca editado, nunca confirmado
nexyconfig.py a configuração do projeto, uma classe de use* campos (configuração)
public/ arquivos servidos na raiz, como public/logo.svg → /logo.svg (convenções de arquivo)
src/apps/ controladores e módulos do roteador modular (modular)
src/components/ componentes importados por páginas; nunca roteia (convenções de arquivo)
src/routes/ as rotas da aplicação (convenções de arquivo)

Próximas etapas

Editar no GitHub

Enter abre o resultado, Esc fecha.