This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow-site.git
The following commit(s) were added to refs/heads/main by this push:
new 241c609d92 Add steps to install Node.js & nmp and HUGO required for
local site build (#775)
241c609d92 is described below
commit 241c609d9235ad7ecab732310d240f64c40ed0f4
Author: Pankaj Koti <[email protected]>
AuthorDate: Wed Apr 26 20:31:42 2023 +0530
Add steps to install Node.js & nmp and HUGO required for local site build
(#775)
---
README.md | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index a451b088b6..d767ca1596 100644
--- a/README.md
+++ b/README.md
@@ -51,7 +51,10 @@ git submodule update --init --recursive
```
---
-In order to build site, run script `<ROOT DIRECTORY>/site.sh build-site`.
+In order to build the site locally,
+1. Install [Node.js and NPM](https://nodejs.org/en/download)
+2. Make sure you have [HUGO](https://gohugo.io/installation/) installed.
You're recommended to install the version that is being used in the [CI
build](https://github.com/apache/airflow-site/blob/main/.github/workflows/build.yml#L53)
job.
+3. Run script `<ROOT DIRECTORY>/site.sh build-site`.
In order to preview landing pages, run script `<ROOT DIRECTORY>/site.sh
preview-landing-pages`.
