Ir para o conteúdo principal
Version: Canary 🚧

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"
}
}

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.
--localeSpecify site locale to be used.
--hot-onlyfalseEnables Hot Module Replacement without page refresh as a fallback in case of build failures. Mais informações aqui.
--no-openfalseDo not open the page automatically in the browser.
--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.
--no-minifyfalseCrie um site sem minimizar os pacotes JS/CSS.
info

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.

Development over network

When forwarding port 3000 from a remote server or VM (e.g. GitHub Codespaces), you can run the dev server on 0.0.0.0 to make it listen on the local IP.

npm run start -- --host 0.0.0.0

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
--devBuilds the website in dev mode, including full React error messages.
--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
--localeBuild the site in the specified locale(s). If not specified, all known locales are built.
--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.

You can skip the HTML minification with the environment variable SKIP_HTML_MINIFICATION=true.

docusaurus swizzle [themeName] [componentName] [siteDir]

Swizzle a theme component to customize it.

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

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

The swizzle CLI is interactive and will guide you through the whole swizzle process.

Opções

NomeDescrição
themeNameThe name of the theme to swizzle from.
componentNameThe name of the theme component to swizzle.
--listDisplay components available for swizzling
--ejectEject the theme component
--wrapWrap the theme component
--dangerAllow immediate swizzling of unsafe components
--typescriptSwizzle the TypeScript variant component
--configPath to docusaurus config file, default to [siteDir]/docusaurus.config.js
warning

Unsafe components have a higher risk of breaking changes due to internal refactorings.

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
--localeDeploy the site in the specified locale(s). If not specified, all known locales are deployed.
--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. This may be useful when using a custom deploy script.
--target-dir.Path to the target directory to deploy to.
--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.
--no-openfalse locally, true in CIDo not open a browser window to the server location.

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 para cada mensagem de tradução, para ajudar a destacar strings não traduzidas

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

Add explicit heading IDs to the Markdown documents of your 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.