Setup

Prerequisites

Contributing to the vCZYZ KB requires a few pieces of software. Ensure you install all of the following before continuing.

• Git
• Visual Studio Code or similar code editor that supports Markdown.
  • During installation, selecting the “Add ‘Open with Code’ to Windows Explorer * menu” options is recommended.
• pnpm
  • Follow the instructions in the “Using a standalone script” section.
  • If you’re on macOS or Linux, use standalone script installation on POSIX systems.

Workspace Setup

See the footnotes for more detailed instructions on some of the steps.

1. Open a new window in VSCode.
2. Clone this repository¹. Use the link given by the “HTTPS” option in the green Code button on the repo page on GitHub. Clone somewhere that’s easily accessible like your Documents folder. Git will create a folder inside the one you select to hold the repo.
3. Open the repo in VSCode once it’s cloned.
4. Open a Terminal in VSCode² and run the following command to install Node.js.

   pnpm env use --global lts

5. Run the following command to set up the code quality tools ESLint and Prettier. They run whenever you commit changes to ensure you don’t push erroneous or misformatted code.

   pnpm i

6. Open the Extensions View³ and install these extensions:
   • Prettier enforces code and Markdown style (indents, tables, etc.)
   • ESLint checks code and Markdown for errors
     Warning

     Do NOT install the confusingly named “Prettier ESLint” extension. Install the two listed above individually!

   • Astro
   • Starlight Links provides support for the modified Markdown internal link format used by Starlight
7. Change the following VSCode settings⁴ (using the searchbar is strongly recommended):
   • Set “Editor: Default Formatter” to “Prettier - Code Formatter esbenp.prettier-vscode”.
   • Enable “Editor: Format on Save”.
   • Enable “Editor: Format on Paste”.

Note

Because Prettier enforces a specific code and Markdown style, you may notice that files you edit change slightly when you save. This is normal. If you’re curious about why we’re using Prettier, read more here.

Great! You should be all set up to contribute now.

Footnotes

1. Cloning Repositories in VS Code ↩

2. Opening a Terminal in VS Code ↩

3. Opening the Extensions View in VS Code ↩

4. Editing Settings in VS Code ↩