From 4bdcfe30801894d76a5a3494415bc340fec07c53 Mon Sep 17 00:00:00 2001 From: suyanhanx Date: Tue, 16 Jan 2024 00:06:41 +0800 Subject: [PATCH] docs(bindings/nodejs): build docs locally doc Signed-off-by: suyanhanx --- bindings/nodejs/README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/bindings/nodejs/README.md b/bindings/nodejs/README.md index 6b079073f65b..3e3490762753 100644 --- a/bindings/nodejs/README.md +++ b/bindings/nodejs/README.md @@ -14,7 +14,17 @@ npm install opendal ## Docs -See our documentations on [opendal.apache.org](https://opendal.apache.org/docs/nodejs/). +See our documentation on [opendal.apache.org](https://opendal.apache.org/docs/nodejs/). + +To build the docs locally, please run the following commands: + +```shell +# Only need to run once unless you want to update the docs theme +pnpm run build:theme + +# Build the docs +pnpm run docs +``` ## Usage