Get started

This guide walks you through creating a TBX textbook and getting it running.

Prerequisites

Configure npm to access @bside-tech/tbx from GitHub Packages:

1. Create a personal access token with read:packages permission
2. Add to ~/.npmrc:

   @bside-tech:registry=https://npm.pkg.github.com
   //npm.pkg.github.com/:_authToken=YOUR_TOKEN

Create a new textbook

Run:

npx @bside-tech/tbx@latest create

Follow the prompts. When the book is created:

1. Install dependencies: npm install
2. Start the dev server: npm run dev
3. Open the Dev bar (bottom right) for quick links to Admin, README, and other resources

Update a textbook

To upgrade your textbook when new TBX versions are released:

npx @bside-tech/tbx@latest update

This updates dependencies and scaffolding. Run it from your textbook project root.

Where to begin