1.14.7

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!

Fogueira Docusaurus {.docImage}

Instalar Git

O Git é um sistema de controle de versão para rastrear alterações no código fonte durante o desenvolvimento do software e pode ajudá-lo a sincronizar e versionar arquivos entre o sistema local e o repositório online. O Git para Windows inclui o Git Bash, um aplicativo de terminal. Se ainda não estiver instalado, consulte Instalando o Git .

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 instalação do Node.js. inclui npm, o gerenciador de pacotes que permite instalar os módulos NPM a partir do seu terminal.

  1. Abra o Terminal em um sistema Mac, Linux ou Unix. Abra o Git Bash em um sistema Windows.
  2. Se você tiver brew em seu sistema operacional, execute o seguinte comando para instalar o Node.
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

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

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.

Crie um repositório GitHub e um clone local

  1. Vá para https://github.com/ e crie uma conta, caso ainda não a tenha.
  2. Clique no botão verde ** Novo ** ou acesse https://github.com/new.
  3. Digite um nome de repositório sem espaços. Por exemplo, docusaurus-tutorial.
  4. Clique em ** Criar repositório ** (sem .gitignore e sem uma licença).

Criar repositório GitHub {.docImage}

  1. No Terminal ou no Git Bash, cd para um diretório em que o clone local será um subdiretório.
cd /Users/NAME/doc_projects # macOS exemplo
# ou
cd /c/NAME/doc_projects # Windows exemplo
  1. 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

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!

Execute o seguinte comando:

npm install --global docusaurus-init

ou se você tiver o Yarn:

yarn global add docusaurus-init
Create a New Site →