X-Git-Url: https://harishankar.org/repos/?p=biaweb2.git;a=blobdiff_plain;f=Readme.md;h=c28876bfe32365bea1717953916c01a8124eb7f5;hp=679cdf22df621fdae19c28f60b0b88b65d435185;hb=HEAD;hpb=ca54cd9a481727176c82a43e7ca452cdbbdbc408

diff --git a/Readme.md b/Readme.md
index 679cdf2..c28876b 100644
--- a/Readme.md
+++ b/Readme.md
@@ -303,4 +303,65 @@ 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 (assumed to be accessible at `host@remote`). 
+
+
+    !/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. 
+
+## Further Customization and Notes
+
+* You can edit the contents of the _templates_ folder to get a more unique look and feel. 
+  Templates are just plain HTML bits with no logic (other than the template vars marked 
+  within curly braces). The __style.css.tpl__ file is the CSS bit that is embedded in 
+  all pages of the site. At present there is no way to get a different look and feel for
+  different categories or parts of the site.
+
+* The file __stringbits.txt__ contain general strings that are used to describe parts of
+  your website. This can also be customized, but each line stands for a particular item 
+  and should not be interchanged. Ensure that changes to a particular line describe the 
+  same item (in a different way). For example the text `List of Articles` may be substituted
+  by `List of Docs` or `Documents` but changing it to `Categories` will not make sense. 
+
+* The generated website from the default template should conform to HTML 5. If there are
+  any errors in the resultant HTML, please raise an 
+  [issue](https://gitlab.com/harishankarv/biaweb2/-/issues/new) to 
+  address it and it will be fixed. In general, please raise an issue for any bugs, 
+  feedback or feature requests. However, as far as features are concerned, there is no 
+  plan to make this a comprehensive website management tool. The key philosophy of this 
+  tool is simplicity and I plan to keep it that way.
+
+* __Limitation of RSS Feed:__ At present the RSS feed generated by the script in 
+  __feed.xml__ does not fetch any articles from sub-categories and only fetches articles from'
+  its own category. This may be addressed in the future, depending on whether this is seen
+  as necessary.
\ No newline at end of file