3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-30 10:48:05 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/docs/tutorial-setup.md
Jay Martin 59b0f9cbac docs: add a cd step before clone in "Setting Up" (#1707) 
* Add a cd step before clone in "Setting Up"

Add a `cd` step before clone in **[Setting Up](https://docusaurus.io/docs/en/next/tutorial-setup)**, add examples of `cd` in steps 5 and 7, and edit other steps.

* Update tutorial-setup.md
2019-07-25 13:27:01 -07:00

3.1 KiB
Raw Blame History

id title
tutorial-setup Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. If not already installed, see Installing Git.

Install Node.js

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps.

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

  1. Open your Terminal.
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
brew install node

Alternatively, you can download an installer from the Node.js homepage.

Check your Node.js installation

Check that you have the minimum required version installed by running the following command:

node -v

You should see a version larger than Node 8.

node -v
v8.15.1

Install Yarn (Optional)

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

You can still proceed with the tutorial without Yarn.

Create a GitHub repository and local clone

  1. Go to https://github.com/ and sign up for an account if you don't already have one.
  2. Click on the green New button or go to https://github.com/new.
  3. Type a repository name without spaces. For example, docusaurus-tutorial.
  4. Click Create repository (without .gitignore and without a license).
GitHub create repo
  1. In your terminal, cd to a directory where the local clone will be a subdirectory. (For help see Introduction to the command-line interface.)
cd /Users/USERNAME/doc_projects # macOS example
# or
cd /c/USERNAME/doc_projects # Windows example
  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 to the directory for the local clone.
cd docusaurus-tutorial

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