Translate

Setting Up

Este tutorial é voltado para usuários iniciantes que desejam instruções detalhadas sobre como ir do zero para um site da Docusaurus que possui versões. Vamos começar!

{.docImage}

Instalar Node.js

Node.js é um ambiente que pode executar código JavaScript fora de um navegador web e é usado para escrever e executar aplicativos JavaScript no lado do servidor.

A versão mínima suportada do Node.js. do Docusaurus é o Node 8, mas as versões mais recentes também funcionam.

1. Abra o Terminal.
2. Se você tiver brew no sistema operacional, execute o seguinte comando para instalar o Node (um ambiente de execução JavaScript que permite executar o JavaScript no servidor) e npm o gerenciador de pacotes (permite que você instale módulos npm a partir do seu terminal).

brew install node

Como alternativa, você pode baixar um instalador da página inicial do Node.js .

Verifique sua instalação do Node.js.

Verifique se você possui a versão mínima necessária instalada executando o seguinte comando:

node -v

Você deve ver uma versão superior ao Node 8.

node -v
v8.15.1

Instalar Yarn (Opcional)

É altamente recomendável que você instale o Yarn, um gerenciador de pacotes alternativo com excelente desempenho para gerenciar suas dependências do NPM. Confira aqui.

Você ainda pode prosseguir com o tutorial sem o Yarn.

Criar um repositório no GitHub

1. Vá para https://github.com/ e crie uma conta, caso ainda não a tenha.
2. Clique em "Novo Repositório" ou acesse https://github.com/new.
3. Nomeie seu repositório sem espaços. Por exemplo, docusaurus-tutorial.
4. Proceda para criar o repositório sem adicionar .gitignore ou uma licença.

{.docImage}

5. Clone seu repositório para a máquina local:

git clone [email protected]:USERNAME/docusaurus-tutorial.git # SSH
# or
git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS

6. cd no repositório que você acabou de criar.

Instale o comando Docusaurus init

O Docusaurus vem com uma ferramenta de linha de comando para ajudá-lo a criar um site do Docusaurus com alguns modelos de exemplo. Vamos instalar o instalador!

1. Execute o seguinte comando:

npm install --global docusaurus-init

ou se você tiver o Yarn:

yarn global add docusaurus-init