GitHub Pages Documentation

This repository uses GitHub Pages to host the documentation.

Setup

1. Go to Settings > Pages
2. Under Build and deployment > Source, select GitHub Actions
3. The documentation will be automatically deployed on:
   • Pushes to main branch (docs changes)
   • Release publishing

Workflows

Workflow	Trigger	Description
ci.yml	Push to main, Pull requests	Build, test, lint
release.yml	GitHub Release published	Publish to npm + docs
docs.yml	Push to main (docs changes), Manual	Deploy docs to GH Pages
publish.yml	Manual dispatch	Manual npm publish

NPM Publishing

Automatic (Recommended)

1. Create a GitHub Release
2. The release.yml workflow will automatically publish to npm

Manual

1. Go to Actions > NPM Publish (Manual)
2. Click Run workflow
3. Select the npm tag (latest, next, beta, alpha)
4. Click Run workflow

Required Secrets

Secret	Description	How to get
NPM_TOKEN	npm authentication token	Generate at https://www.npmjs.com/settings/tokens

Setting up NPM_TOKEN

1. Create an npm account or use existing one
2. Generate an Automation token at https://www.npmjs.com/settings/your-username/tokens
3. Add the token as a repository secret:
   • Go to Settings > Secrets and variables > Actions
   • Click New repository secret
   • Name: NPM_TOKEN
   • Value: Your npm token
   • Click Add secret

Documentation URL

After enabling GitHub Pages, the documentation will be available at:

https://srah.github.io/node-apk/

Local Development

# Start docs dev server
npm run docs:dev

# Build docs
npm run docs:build

# Preview production build
npm run docs:preview