Skip to content

README.md

Latest commit

 

History

History
38 lines (25 loc) · 1.11 KB

README.md

File metadata and controls

38 lines (25 loc) · 1.11 KB
Raw

Botble Documentation

Requirements

  • Node.js ≥ 20 (see .nvmrc)
  • npm (canonical lockfile is package-lock.json)

Setup

git clone https://github.com/botble/docs.git

npm install

npm run docs:dev

npm run docs:dev and npm run docs:build automatically run bin/shell_cmd.sh first to sync shared CMS docs into each theme.

npm run docs:build also checks sidebar links and local assets before building, then checks anchors against the generated HTML. Any detected error fails the build.

Deploy

bin/deploy.sh             # build locally, upload to docs.botble.com, switch atomically
bin/deploy.sh --rollback  # point the site back at the previous release

Never build on the server: it has too little RAM and the build takes every site on it down.

Redirects

Redirects for removed or renamed pages live in bin/nginx/redirects-docs.botble.com.conf. On the server it is /usr/local/nginx/conf/redirects-docs.botble.com.conf, included from conf.d/docs.botble.com.ssl.conf. bin/deploy.sh does not upload it: after editing, copy it to the server, then run nginx -t && nginx -s reload.