mount substitution
[pinopress.git] / README.md
index 5b725d6..2a202a7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -56,5 +56,17 @@ pinopress articles are written in an enhanced version of markdown. specification
 
 ## mounts
 
-many times, you would like to display a list of html elements somewhere in the page. **pinopress** solves this using mounts. mounts are simply comments that tell pinopress where to append template items.
+mounts are the **pinopress** solution to html includes. to include any file from the template directory, use the following syntax:
+```
+<!-- MOUNT_[NAMEOFFILE] -->
+```
+note that the name of file is without any extensions and in all caps. also, mounts are **not** expanded recursively.
+
+**pinopress** also has the following builtin mounts that are used internally, prefixed by an underscore:
+```
+<!-- _MOUNT_ARTICLECONTENT -->
+<!-- _MOUNT_ROLLINGITEM -->
+<!-- _MOUNT_ARCHIVEITEM -->
+<!-- _MOUNT_FEEDITEM -->
+```