1.11.x

Translate

Installation

O Docusaurus foi projetado desde o início para ser facilmente instalado e usado, para que você crie seu site rapidamente e sem muito esforço.

Instalando o Docusaurus

Nós criamos um script fácil que irá deixar toda a infraestrutura necessária no jeito para você:

  1. Verifique se você tem a versão mais recente do Node instalada. Recomendamos que você também instale o Yarn.

    Você precisa ter o Node >= 8.x e o Yarn >= 1.5.

  2. Create a project, if none exists, and change your directory to this project's root.

    Você estará criando a documentação neste diretório. O Diretório principal conterá outros arquivos. O script de instalação do Docusaurus Criará doas novas pastas: docs e website.

    Na maioria das vezes, o local do seu site Docusaurus será um projeto do GitHub, seja ele um já existente ou um recém-criado, mas isso não é obrigatório para que o Docusaurus seja usado.

  3. Execute o script de instalação do Docusaurus: npx docusaurus-init.

    Se você não tiver o Node a partir da versão 8.2 ou caso prefira instalar o Docusaurus globalmente, execute yarn global add docusaurus-init ou npm install --global docusaurus-init. Depois disso, execute docusaurus-init.

Verificando a instalação

Juntamente com as pastas e arquivos existentes, seu diretório raiz agora vai conter uma estrutura semelhante a esta:

root-directory
├── Dockerfile
├── README.md
├── docker-compose.yml
├── docs
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   ├── exampledoc4.md
│   └── exampledoc5.md
└── website
    ├── blog
    │   ├── 2016-03-11-blog-post.md
    │   ├── 2017-04-10-blog-post-two.md
    │   ├── 2017-09-25-testing-rss.md
    │   ├── 2017-09-26-adding-rss.md
    │   └── 2017-10-24-new-version-1.0.0.md
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

Rodando o site de exemplo

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. Para rodá-lo:

  1. cd website

  2. From within the website directory, run the local web server using yarn start or npm start.

  3. Load the example site at http://localhost:3000 if it did not already open automatically. Se a porta 3000 já estiver em uso, outra porta será usada. Olhe para as mensagens do console para ver qual é.

    Agora você deve estar vendo o site de exemplo carregado no seu navegador web. Também tem um servidor LiveReload rodando - ou seja, quaisquer alterações que você fizer nos documentos e arquivos no diretório website farão a página recarregar automaticamente. Uma cor de tema primária e secundária gerada aleatoriamente será escolhida para você.

Iniciando o servidor por trás de um proxy

Se sua conexão com a Internet estiver por trás de um proxy corporativo, você precisa desativá-lo para que as requisições para o servidor de desenvolvimento funcionem adequadamente. Isso pode ser feito usando a variável de ambiente NO_PROXY.

SET NO_PROXY=localhost
yarn start (ou npm run start)

Atualizando sua versão do Docusaurus

A qualquer momento após o Docusaurus ser instalado, você poderá verificar a versão atualmente instalada dele indo até o diretório website e executando yarn outdated docusaurus ou npm outdated docusaurus.

Você verá algo assim:

$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
warning package.json: No license field
warning No license field
info Color legend :
 "<red>"    : Major Update backward-incompatible updates
 "<yellow>" : Minor Update backward-compatible features
 "<green>"  : Patch Update backward-compatible bug fixes
Package    Current Wanted Latest Package Type    URL
docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/docusaurus#readme
✨  Done in 0.41s.

Se os comandos outdated não retornarem nenhuma versão perceptível, então você está atualizado.

Você pode atualizar para a versão mais recente do Docusaurus usando:

yarn upgrade docusaurus --latest

ou

npm update docusaurus

Caso você comece a receber erros após a atualização, tente ou limpar seu cache do Babel (geralmente está em um diretório temporário) ou rodar o servidor do Docusaurus (ex.: yarn start) com a configuração de ambiente BABEL_DISABLE_CACHE=1.

Site Preparation →