Skip to content

Repository files navigation

vmdocs

Documentation monorepo for the cloudapp3 projects published on bestcheapvps.org subdomains.

ProjectLive documentationSource
vminfohttps://vminfo.bestcheapvps.orghttps://github.com/cloudapp3/vminfo
vmbenchhttps://vmbench.bestcheapvps.orghttps://github.com/cloudapp3/vmbench
vmflowhttps://vmflow.bestcheapvps.orghttps://github.com/cloudapp3/vmflow
tgbothttps://tgbot.bestcheapvps.orghttps://github.com/cloudapp3/tgbot

Repository layout

Each site owns its VitePress config, Markdown, theme overrides, and public assets:

sites/<project>/docs/

Dependencies and site-specific scripts live at the repository root. Build output stays isolated under sites/<project>/docs/.vitepress/dist and is not committed.

Local development

Install the pinned dependencies:

corepack enable
pnpm install --frozen-lockfile

Use the project-specific commands:

ProjectDevelopmentBuildPreview
vminfopnpm docs:dev:vminfopnpm docs:build:vminfopnpm docs:preview:vminfo
vmbenchpnpm docs:dev:vmbenchpnpm docs:build:vmbenchpnpm docs:preview:vmbench
vmflowpnpm docs:dev:vmflowpnpm docs:build:vmflowpnpm docs:preview:vmflow
tgbotpnpm docs:dev:tgbotpnpm docs:build:tgbotpnpm docs:preview:tgbot

The compatibility aliases docs:dev, docs:build, and docs:preview continue to target vminfo.

Cloudflare Pages

Create one Pages project per documentation site. Use the repository root /, Node 22, and the matching site command and output path.

For tgbot:

SettingValue
Production branchmain
Build commandpnpm docs:build:tgbot
Build output directorysites/tgbot/docs/.vitepress/dist
Root directory/
Node.js version22

When the Pages project needs an explicit install step, use:

corepack enable&& pnpm install --frozen-lockfile && pnpm docs:build:tgbot

The site is published at the custom-domain root, so VitePress does not set base. Add the custom domain in Pages before changing DNS.

Before launch, confirm that tgbot.bestcheapvps.org resolves to the Pages project and serves HTTPS. In Cloudflare, add a host-based redirect from the production *.pages.dev hostname to https://tgbot.bestcheapvps.org while preserving the path and query string. If the default hostname must remain reachable, apply an X-Robots-Tag: noindex response-header rule to that hostname only. Do not put that directive in sites/tgbot/docs/public/_headers, because the same static file is also served from the canonical custom domain.

About

VMDocs

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages