docusaurus.md

ℼ

Install Docusarus

• README
• Introduction
• GitHub and SSH
• Cloning GitHub Repo
• Installing Docusaurus
• Local Test
• GitHub Page Deployment

ℼ

Introduction

This part is not included in the OVA file because it contains SSH KEYS and GitHub account information. This part will use the user account "cbkadal" as an example. Remember, you are not "cbkadal," so you should replace "cbkadal" with your account. Again, you are not "cbkadal," so you should replace "cbkadal" with your account.

ℼ

GitHub and SSH

• In this example, we will use the GitHub account "cbkadal" and repo https://github.com/yforku/DocuDemo/. You should replace it with your own. See also README.
• Generating a GnuPG KEY PAIR. See https://osp4diss.vlsm.org/osp-110.html.
• Put a Public Key at GitHub.com. See https://osp4diss.vlsm.org/osp-111.html.
• Setting .gitconfig. See https://osp4diss.vlsm.org/osp-112.html.

ℼ

Cloning GitHub Repo

• In this example, we will use the GitHub account "cbkadal" and repo https://github.com/yforku/DocuDemo/. You should replace it with your own. See also README.
• Test your SSH connection to GitHub.

#!/bin/bash
ssh -T git@github.com

• You are not cbkadal! You should replace GIT_USER, ORG, and REPO with your own.
  • GIT_USER: "cbkadal"
  • ORG: "yforku"
  • REPO: "DocuDemo"
  • LINK: https://github.com/yforku/DocuDemo/

#!/bin/bash
echo You are not cbkadal! You should replace GIT_USER, ORG, and REPO with your own.
sleep 2
REPO="DocuDemo"
GIT_USER="cbkadal"
ORG="yforku"
USE_SSH="true"
LINK="$ORG/${REPO}.git"
echo The GIT LINK IS git@github.com:$LINK

• Cloning

#!/bin/bash
mkdir -vp $HOME/git/
[ -d $HOME/git/ ] || { echo "ERROR: no git directory!"; exit 1; }
cd $HOME/git/
git clone git@github.com:$LINK
[ -d $HOME/git/$REPO/ ] || { echo "ERROR: no $REPO repo!"; exit 1; }
cd $HOME/git/$REPO/
git status
ls -aF

ℼ

Installing Docusaurus

• You may replace "REPO" with your own repo.

#!/bin/bash
echo "Using repo $REPO/"
sleep 2
[ -d $HOME/git/$REPO/ ] || { echo "ERROR: no git directory!"; exit 1; }
cd $HOME/git/$REPO/
echo "Installing Docusaurus..."
npm init docusaurus@latest Docusaurus classic
cd $HOME/git/$REPO/Docusaurus/
ls -al

ℼ

Local Test

• Run

#!/bin/bash
cd $HOME/git/$REPO/Docusaurus/
npm run start -- --host 0.0.0.0

• NAT from port 3000 to port 5001
• At your host, use
  • http://localhost:5001/

ℼ

GitHub Page Deployment

• E.g., for deploying https://yforku.github.io/DocuDemo/, modify the following in file "docusaurus.config.js":

  title: 'DocuDemo',                // Or else
  tagline: 'This is the Way!',      // Or else
  favicon: 'img/favicon.ico',       // Or else
  url: 'https://yforku.github.io',  // Or else
  baseUrl: '/DocuDemo/',            // Or else
  organizationName: 'yforku',       // (Usually your GitHub org/user name)
  projectName: 'DocuDemo',          // (Usually your repo name)
  trailingSlash: true,              // "true/" or "false"

• Deploy yarn

#!/bin/bash
[ -d $HOME/git/$REPO/Docusaurus/ ] || { echo "ERROR: no git directory!"; exit 1; }
cd $HOME/git/$REPO/Docusaurus/
yarn deploy

ℼ

This is the Way!

#### REV02: Sat 06 May 2023 22:00
#### REV01: Fri 05 May 2023 20:00
#### START: Fri 05 May 2023 15:00