Ir para o conteúdo principal
Version: 2.0.0-beta.10 🚧

CLI

Docusaurus fornece um conjunto de scripts para ajudá-lo a gerar, servir e implantar seu site.

Assim que seu site for inicializado, a fonte do site conterá os scripts Docusaurus que você pode invocar com seu gerenciador de pacotes:

package.json
{
// ...
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
}
}

Index

Comandos do Docusaurus CLI

Abaixo está uma lista dos comandos do Docusaurus CLI e seus usos:

docusaurus start [siteDir]

Constrói e fornece uma visualização de seu site localmente com o Webpack Dev Server.

Opções

NomePadrãoDescrição
--port3000Especifica a porta do servidor de desenvolvimento.
--hostlocalhostEspecifique um host a ser usado. Por exemplo, se você quer que seu servidor seja acessível externamente, você pode usar --host 0.0.0.0.
--hot-onlyfalseHabilita Substituição de Módulos Quentes sem atualizar a página como recurso em caso de falhas de construção. Mais informações aqui.
--no-openfalseNão abrir automaticamente a página no navegador.
--configundefinedCaminho para o arquivo de configuração do docusaurus, padrão para [siteDir]/docusaurus.config.js
--poll [optionalIntervalMs]falseUse a pesquisa de arquivos em vez de observar a recarga ao vivo como uma alternativa em ambientes onde a vigilância não funciona. Mais informações aqui.
important

Por favor note que algumas funcionalidades (por exemplo, links de ancoragem) não funcionarão em desenvolvimento. A funcionalidade irá se comportar conforme o esperado em produção.

Habilitando HTTPS

Existem várias maneiras de obter um certificado. Vamos usar o mkcert como um exemplo.

  1. Execute mkcert localhost para gerar localhost.pem + localhost-key.pem

  2. Execute mkcert -install para instalar o certificado em seu armazenamento confiável e reinicie seu navegador

  3. Inicie o aplicativo com variáveis de ambiente Docusaurus HTTPS:

HTTPS=true SSL_CRT_FILE=localhost.pem SSL_KEY_FILE=localhost-key.pem yarn start
  1. Abra https://localhost:3000/

docusaurus build [siteDir]

Compila seu local para produção.

Opções

NomePadrãoDescrição
--bundle-analyzerfalseAnalise seu pacote com o analisador de pacote webpack.
--out-dirbuildO caminho completo para o novo diretório de saída, relativo ao espaço de trabalho atual.
--configundefinedCaminho para o arquivo de configuração do docusaurus, padrão para [siteDir]/docusaurus.config.js
--no-minifyfalseCrie um site sem minimizar os pacotes JS/CSS.
info

Para a minimização avançada do pacote CSS, usamos a predefinição cssnano avançada (junto com vários plug-ins PostCSS adicionais) e otimização de nível 2 do clean-css. Se, como resultado dessa minimização CSS avançada, você encontrar CSS quebrado, construa seu site com a variável de ambiente USE_SIMPLE_CSS_MINIFIER=true para reduzir CSS com o predefinição cssnano padrão. Por favor preencha uma issue se você tiver experimentado bugs de minificação CSS.

docusaurus swizzle [siteDir]

caution

Nós desencorajamos o swizzling de componentes durante a fase beta do Docusaurus 2. É provável que as APIs dos componentes do tema evoluam e tenham alterações significativas. Se possível, mantenha a aparência padrão por enquanto.

Mude qualquer componente do tema Docusaurus ao seu gosto com o npm run swizzle.

npm run swizzle [themeName] [componentName] [siteDir]

# Example (leaving out the siteDir to indicate this directory)
npm run swizzle @docusaurus/theme-classic DocSidebar

Executar o comando irá copiar os arquivos de temas relevantes para a pasta do site. Você pode então fazer qualquer alterações nele e o Docusaurus irá usá-lo em vez do fornecido no tema.

npm run swizzle sem themeName lista todos os temas disponíveis para swizzling; Da mesma forma, npm run swizzle <themeName> sem componentName lista todos os componentes disponíveis para deslizar o dispositivo.

Opções

NomeDescrição
themeNameO nome do tema que você está usando.
swizzleComponentO nome do componente a ser varrido.
--dangerPermitir swizzling de componentes instáveis
--typescriptComponentes Swizzle TypeScript

Um exemplo para usar a flag --danger vamos considerar o código abaixo:

npm run swizzle @docusaurus/theme-classic Logo -- --danger
caution

Componentes instáveis: componentes que têm um risco maior de quebra de alterações devido a refatorações internas.

Para unswizzle um componente, simplesmente apague os arquivos do componente swizzled.

docusaurus deploy [siteDir]

Faça deploy do seu site com o GitHub Pages. Confira a documentação em deployment para mais detalhes.

Opções

NomePadrãoDescrição
--out-dirbuildO caminho completo para o novo diretório de saída, relativo ao espaço de trabalho atual.
--skip-buildfalseImplante o site sem construí-lo. Isso pode ser útil ao usar o script de implantação customizado.
--configundefinedCaminho para o arquivo de configuração do docusaurus, padrão para [siteDir]/docusaurus.config.js

docusaurus serve [siteDir]

Disponibilize o site construído localmente.

NomePadrãoDescrição
--port3000Usar porta especificada
--dirbuildO caminho completo para o diretório de saída, relativo ao espaço de trabalho atual
--buildfalseCrie um site antes de servir
--configundefinedCaminho para o arquivo de configuração do docusaurus, padrão para [siteDir]/docusaurus.config.js
--hostlocalhostEspecifique um host a ser usado. Por exemplo, se você quer que seu servidor seja acessível externamente, você pode usar --host 0.0.0.0.

docusaurus clear [siteDir]

Limpe os assets gerados pelo site do Docusaurus. Caches e artefatos de construção.

Recomendamos executar esse comando antes de relatar bugs, depois de atualizar versões ou a qualquer momento que você tenha problemas com o seu site Docusaurus.

docusaurus write-translations [siteDir]

Escreva os arquivos de tradução JSON que você terá que traduzir.

Por padrão, os arquivos são escritos em website/i18n/<defaultLocale>/....

NomePadrãoDescrição
--locale<defaultLocale>Defina em qual pasta de localização você deseja escrever as traduções dos arquivos JSON
--overridefalseSubstituir as mensagens de tradução existentes
--configundefinedCaminho para o arquivo de configuração do docusaurus, padrão para [siteDir]/docusaurus.config.js
--messagePrefix''Permite adicionar um prefixo a cada mensagem de tradução, para ajudá-lo a destacar frases não traduzidas

docusaurus write-heading-ids [siteDir] [files]

Adicione Ids de título explícitos aos documentos Markdown do seu site.

NomePadrãoDescrição
filesAll MD files used by pluginsThe files that you want heading IDs to be written to.
--maintain-casefalseKeep the headings' casing, otherwise make all lowercase.
--overwritefalseOverwrite existing heading IDs.