Wiki

How to Build and Manage Your Website Locally

Recommended Usage

For the first-time setup, run:

yarn
node runScripts.js

For subsequent uses, simply run:

node runScripts.js

Running the Mind Map Generator

Python Script: generate_mindmap.py

Generates a mindmap.mmd file with the structure of your docs folder.

Usage:

1. Ensure Python is installed:

   python --version

2. Navigate to the script's directory and run:

   python generate_mindmap.py

Converting .mmd to Image

Converts the generated mindmap.mmd file to a PNG image using Mermaid CLI.

Usage:

1. Ensure Node.js and Mermaid CLI are installed:

   node --version
   npm install -g @mermaid-js/mermaid-cli

2. Navigate to the script's directory and run:

   mmdc -i mindmap.mmd -o src/generated/mindmap.png

Running the Docker Command

Docker Command for Algolia Search

Runs the Docker command to execute the Algolia DocSearch scraper.

Usage:

1. Ensure Docker is installed:

   docker --version

2. Run the Docker command:

   docker run -it --env-file=.env -e "CONFIG=$(cat ./config.json | jq -r tostring)" algolia/docsearch-scraper

---

---

---

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

---

---

---