You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by su...@apache.org on 2024/01/15 16:06:54 UTC
(incubator-opendal) branch docs-build-doc created (now 4bdcfe3080)
This is an automated email from the ASF dual-hosted git repository.
suyanhanx pushed a change to branch docs-build-doc
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
at 4bdcfe3080 docs(bindings/nodejs): build docs locally doc
This branch includes the following new commits:
new 4bdcfe3080 docs(bindings/nodejs): build docs locally doc
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(incubator-opendal) 01/01: docs(bindings/nodejs): build docs locally doc
Posted by su...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
suyanhanx pushed a commit to branch docs-build-doc
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
commit 4bdcfe30801894d76a5a3494415bc340fec07c53
Author: suyanhanx <su...@gmail.com>
AuthorDate: Tue Jan 16 00:06:41 2024 +0800
docs(bindings/nodejs): build docs locally doc
Signed-off-by: suyanhanx <su...@gmail.com>
---
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 6b079073f6..3e34907627 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