Skip to content

Repository files navigation

docs

Documentation site for NVM for Windows (Docusaurus).

Local development

npm ci
npm start

Build

npm run build

Static output is written to build/.

Deploy to Cloudflare Pages

Production deploys use Direct Upload (not Cloudflare Git integration).

One-time setup

  1. Create a Cloudflare API token with Account → Cloudflare Pages → Edit.

  2. Create the Pages project (once):

    npx wrangler pages project create nvm-windows-docs --production-branch=main

    Or deploy once with Wrangler logged in; the project is created on first upload.

  3. In GitHub repo settings → Secrets and variables → Actions, add:

    • CLOUDFLARE_API_TOKEN
    • CLOUDFLARE_ACCOUNT_ID
  4. In the Cloudflare dashboard, attach custom domain docs.nvm-windows.com to project nvm-windows-docs.

Direct Upload projects cannot later switch to Pages Git integration; create a new project if you need that.

Local deploy

Requires Wrangler auth (npx wrangler login) or CLOUDFLARE_API_TOKEN + CLOUDFLARE_ACCOUNT_ID in the environment:

npm run deploy

This runs npm run build, then:

wrangler pages deploy ./build --project-name=nvm-windows-docs --branch=main

Automated deploy (releases)

Publishing a GitHub Release triggers .github/workflows/deploy-pages.yml, which checks out the release tag and deploys build/ to Cloudflare Pages production (--branch=main).

You can also run the workflow manually via Actions → Deploy Cloudflare Pages → Run workflow.

About

Documentation site for nvm-windows

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages