Variáveis

Defina um valor uma vez no blume.config.ts e escreva {{name}} em qualquer lugar onde uma página precisar dele, seja no texto, no código, em links ou em props de componentes.

Defina um valor uma vez e use-o em todas as páginas. Um número de versão, um host de API ou o nome de um produto fica em blume.config.ts, e {{name}} em uma página lê o valor correspondente:

export default defineConfig({
  variables: {
    version: "2.1.0",
    "api-url": "https://api.example.com",
  },
});

Install version {{version}}, then call {{api-url}}.

## What's new in {{version}}

<Card title="Release {{version}}" href="{{api-url}}/changelog" />

As referências funcionam no texto, em títulos, links, blocos de código, código inline e props de componentes, tanto em páginas .md e .mdx quanto nos arquivos que elas incluem. Espaços dentro das chaves não têm problema ({{ version }}). Altere o valor na configuração e todas as páginas vão refletir a mudança no próximo build.

Os nomes aceitam letras, dígitos, _ e -. Os valores são texto simples em uma única linha.

Onde elas se aplicam

Uma variável é substituída antes que qualquer coisa leia a página, então o HTML renderizado, a busca, o espelho .md da página e o llms-full.txt mostram o valor.

O frontmatter fica como foi escrito: um title ou description com {{version}} mostra as chaves.

Nomes não definidos

Um {{name}} não definido no texto gera um erro de build, BLUME_UNDEFINED_VARIABLE, reportado na linha em que aparece, para que um erro de digitação nunca chegue aos leitores. Dentro de um bloco de código ou de código inline, um nome não definido fica como foi escrito, já que exemplos de templates, como um {{title}} do Handlebars, são comuns nesses lugares.

Para mostrar uma referência no texto sem defini-la, coloque-a em código inline: `{{name}}`.

Um site que não define nenhuma variável não é afetado: {{…}} nas páginas dele fica como foi escrito.