camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From zregv...@apache.org
Subject camel git commit: CAMEL-11492 New Camel website - added README.md
Date Mon, 03 Jul 2017 21:59:09 GMT
Repository: camel
Updated Branches:
  refs/heads/website 14743869c -> e5942e005


CAMEL-11492 New Camel website - added README.md


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/e5942e00
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/e5942e00
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/e5942e00

Branch: refs/heads/website
Commit: e5942e0052e822ecba97d6205ba0e9a51e9b79c7
Parents: 1474386
Author: Zoran Regvart <zregvart@apache.org>
Authored: Mon Jul 3 23:59:06 2017 +0200
Committer: Zoran Regvart <zregvart@apache.org>
Committed: Mon Jul 3 23:59:06 2017 +0200

----------------------------------------------------------------------
 camel-website/README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/e5942e00/camel-website/README.md
----------------------------------------------------------------------
diff --git a/camel-website/README.md b/camel-website/README.md
new file mode 100644
index 0000000..8434e32
--- /dev/null
+++ b/camel-website/README.md
@@ -0,0 +1,40 @@
+# Camel Website
+
+This is a site generator project for Apache Camel. It generates static HTML and
+resources that are to be published. Tools used to generate the website:
+ - [Gulp](http://gulpjs.com/) a task automation tool. It is used to gather
+   documentation files from the Camel source tree and filter and copy them into
+   the `content` folder.
+ - [Hugo](https://gohugo.io) a static site generator. Simplified, it takes the
+   documentation from the `content` folder and applies templates from `layouts`
+   folder and together with any resources in `static` folder generates output in
+   the `public` folder.
+ - [Yarn](https://yarnpkg.io) - JavaScript dependency management and script
+   runner. Used to bring in all tooling (Gulp, Hugo, Webpack, ...) and other
+   dependencies (Skeleton CSS framework for example) and run `build` and `watch`
+   scripts.
+ - [Webpack](https://webpack.js.org/) - JavaScript and CSS module bundler, it
+   generates JavaScript in `static/js` and CSS in `static/css` bundles from
+   `src/scripts` and `src/stylesheets` respectively.
+
+## Building the website
+
+To build the website run:
+
+    $ yarn // needed only once, or if dependencies change
+    $ yarn build // to perform the build
+
+This should generate the website in the `public` folder.
+
+## Working on the website
+
+When working on the website it is nice to see the effects of the change
+immediately, to that end you can run:
+
+    $ yarn // needed only once, or if dependencies change
+    $ yarn build // to perform the build
+    $ yarn serve // serve the website on http://localhost:1313 and react on \
+                    changed files
+
+If a file is changed tools react on that change and a script present in the
+website performs a reload (livereload).


Mime
View raw message