Beacon

Install Beacon

Install Beacon on your local machine.

Create the site project

Create a new project, <my-project>:

npm create beacon-docs@latest <my-project>

Specify the project and product names

When prompted, specify:

  • <my-project>: The project name

  • <my-product>: The product name that this documentation describes

Review what the command does

The command performs the following tasks:

  1. Downloads Beacon.

  2. Adds starter pages.

  3. Saves the product name in .env.local.

  4. Creates a local Git repository with an initial commit.

  5. Installs the dependencies.

Change to the project directory

cd <my-project>