# Pigster Churn - Docusaurus 2

# Project summary

A website for recording all my recorded video gameplays using Docusaurus.

# 🌐 Page

🌐 Pigster Churn
https://pigsterchurn.github.io/

# Github repository

🚀 pigsterchurn.github.io
https://github.com/pigsterchurn/pigsterchurn.github.io

# Setup guide

The setup and deploy guide is up to date with version 2.0.0-beta.8

  1. Initialization:
npx create-docusaurus@latest <repo_name> classic
  1. Run Docusaurus:
cd <repo_name>
npm run start

# Deploy to Github Pages

# Prerequisites

  1. Go to Github Pages at https://github.com/<github_user>/<repo>/settings/pages.
  2. Select gh-pages branch with /(root) and save.
  3. Modify docusaurus.config.js and add the following params:
    1. organizationName: pigsterchurn
    2. projectName: pigsterchurn.github.io

# Deployment

GIT_USER=pigsterchurn DEPLOYMENT_BRANCH=gh-pages yarn deploy

# Official guides