1.10.x

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 Node.js

O Node.js é um ambiente que pode executar o código JavaScript fora de um navegador da web e é usado para gravar e executar aplicativos JavaScript 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 tempo de execução JavaScript que permite executar o JavaScript no servidor) e npm o gerenciador de pacotes (permite você instala 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 maior que o Nó 8.

node -v
v8.15.1

Install Yarn (Optional)

We highly recommend you to install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

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

Create a GitHub Repository

  1. Vá para https://github.com/ e crie uma conta, caso ainda não a tenha.
  2. Click on "New Repository" or go to https://github.com/new.
  3. Name your repository without spaces. For e.g. docusaurus-tutorial.
  4. Proceed to create the repository without adding .gitignore or a license.

GitHub create repo {.docImage}

  1. Clone your repository to your local machine:
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
# or
git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
  1. cd into the repository which you just created.

Install the Docusaurus init command

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

  1. Run the following command:
npm install --global docusaurus-init

or if you have Yarn:

yarn global add docusaurus-init
Create a New Site →