This is an automated email from the ASF dual-hosted git repository.
zregvart pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-website.git
The following commit(s) were added to refs/heads/master by this push:
new 0d8642d CAMEL-15419: Enhance website build instructions
0d8642d is described below
commit 0d8642d6327265af40b23a2f4d0a3b7ece53c126
Author: amdmdi <[email protected]>
AuthorDate: Fri Aug 21 20:29:43 2020 +0200
CAMEL-15419: Enhance website build instructions
"yarn format" is supported only in antora-ui-camel dir
---
README.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 955ace6..e5a6f5c 100644
--- a/README.md
+++ b/README.md
@@ -120,10 +120,13 @@ inside [Project root
directory/antora-ui-camel](antora-ui-camel). So first switc
In that directory execute:
$ yarn install # needed only once, or if dependencies change
+ $ yarn format # to format the code
$ yarn build # to perform the ui theme build
You should see the Antora theme bundle generated in in
[antora-ui-camel/build/ui-bundle.zip](antora-ui-camel).
+In case `yarn build` raises error, run `yarn format` to format the code and
re-run `yarn build` to build your bundle successfully.
+
The Camel Antora UI theme should not be a subject to change very frequently.
So you might execute this once and
never come back.
@@ -135,10 +138,8 @@ the theme bundle exists in
[antora-ui-camel/build/ui-bundle.zip](antora-ui-camel
To build the website go to the project root directory and run:
$ yarn install # needed only once, or if dependencies change
- $ yarn format # to format the code
$ yarn build # to perform the build
-In case `yarn build` raises error, run `yarn format` to format the code and
re-run `yarn build` to build your bundle successfully.
In case `yarn build` throws the error: **JavaScript heap out of memory**, the
issue can be resolved by increasing the memory used by node.js by setting
`NODE_OPTIONS` environment variable to include `--max_old_space_size`, for
example to increase the old space to 4GB do:
