From: Harishankar <v.harishankar@gmail.com>
Date: Tue, 26 May 2020 13:53:38 +0000 (+0530)
Subject: Readme.md completed
X-Git-Url: https://harishankar.org/repos/?a=commitdiff_plain;h=ca30e23ab5330efb3a9502f3a421bbba45067187;p=biaweb2.git

Readme.md completed

Completed Readme.md - TODO: fix any mistakes or add a FAQ if
required
---

diff --git a/Readme.md b/Readme.md
index 679cdf2..3316b43 100644
--- a/Readme.md
+++ b/Readme.md
@@ -303,4 +303,38 @@ content (i.e. removed files / folders from the source tree):
 
     !/bin/sh 
     rm -rf Out/
-    /path/to/biaweb2/biaweb2 -i Home -t templates -o Out
\ No newline at end of file
+    /path/to/biaweb2/biaweb2 -i Home -t templates -o Out
+
+### Recommendations for Uploading Content and Static Resources
+
+Often, a website is more than just the HTML pages. You have images, for instance needed by
+your pages. While BiaWeb2 does not handle static content, it's quite easy to deal with static
+content, since they need to be uploaded to a fixed location on your website. The `gensite.sh`
+script can be adapted to copy/sync your remote website with the generated output of BiaWeb2
+as well as static resources by adding a couple of extra lines:
+
+Assume that we keep our static resources (like images) in _images_ within the folder 
+_/path/to/mywebsite/images_. We can set the script to automatically sync the images 
+folder with your remote website. 
+
+
+    !/bin/sh 
+    rm -rf Out/
+    /path/to/biaweb2/biaweb2 -i Home -t templates -o Out
+
+    # Sync contents of the Out folder with the remote site at host@remote
+    rsync -avrz --delete ~/path/to/mywebsite/Out/ host@remote:/path/to/www/
+
+    # Sync static resources such as images to remote website
+    rsync -avrz --delete /path/to/mywebsite/images/ host@remote:/path/to/www/images
+
+The resources can then be linked from your individual pages with markdown like this
+
+    ...
+    # Heading 
+
+    This is some content
+    ![My image](images/testimage.jpg)
+
+Since BiaWeb2 uses the `<base>` tag to define the base URL, the above code will work 
+from any location on your website. 
\ No newline at end of file