You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by zr...@apache.org on 2019/03/13 12:15:13 UTC

[camel-website] branch master updated: chore: Add description how to preview the site locally

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 e49f175  chore: Add description how to preview the site locally
e49f175 is described below

commit e49f175dc738171f60e249623fe714c2ba95e5ae
Author: Christoph Deppisch <cd...@redhat.com>
AuthorDate: Wed Mar 13 11:50:42 2019 +0100

    chore: Add description how to preview the site locally
---
 README.md    | 15 +++++++++++++++
 package.json |  3 ++-
 2 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1472b8d..bbe1c0d 100644
--- a/README.md
+++ b/README.md
@@ -99,6 +99,21 @@ To build the website go to the project root folder and run:
 This should fetch doc sources for [Camel](https://github.com/apache/camel) and [Camel K](https://github.com/apache/camel-k) 
 and generate the website with Hugo. You should see the generated website in the `public` folder.
 
+## Preview website locally
+
+You can preview the Apache Camel website on your local machine once you have the generated website available in 
+the `public` folder.
+
+Hugo can start a simple web server serving the generated site content so you can view it in your favorite browser. 
+
+Simply call
+
+    $ yarn preview
+    
+and you will be provided with a web server running the site on [http://localhost:1313/](http://localhost:1313/) 
+
+Point your favorite browser to `http://localhost:1313/` and you will see the Apache Camel website.
+
 ## Build with Maven
 
 The project provides a simple way to build the website sources locally using the build tool [Maven](https://maven.apache.org/).
diff --git a/package.json b/package.json
index ab1512f..f9b06df 100644
--- a/package.json
+++ b/package.json
@@ -6,7 +6,8 @@
     "website": "hugo --minify",
     "critical": "gulp critical",
     "minify": "gulp minify",
-    "build": "run-s documentation website minify critical"
+    "build": "run-s documentation website minify critical",
+    "preview": "hugo server -D"
   },
   "devDependencies": {
     "@antora/cli": "^2.0.0",