semi passable css

[pinopress.git] / README.md

diff --git a/README.md b/README.md
index e7fb04f..b8cd7b2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,29 +1,32 @@
 # pinopress
 
 **pinopress** is a modular makefile based static blog generator. that means you run the build script once and every page is generated beforehand.
+**pinopress** also focuses on extensibility, you can hook your own shell scripts into the build process to easily add any new features.
 
 built in features include markdown generated blog articles, and a rss feed.
 
 ## templates
 
-templates are html snippets that you can customize. these templates are then pieced together to form the final html page. edit them to your liking. they can be found in the `templates/` directory. Here's a brief description of each one:
+templates are html snippets that you can customize. these templates are then pieced together to form the final html page. edit them to your liking. they can be found in the `templates/` directory. Here's a brief description of each one that comes by default:
 
 template          | description
 ------------------|-----------
-head              | html before body
-foot              | html after body
-archivebody       | everything inside body of archive page
-archiveitem       | 
-rollingbody       | everything inside body of rolling page
-rollingitem       |
+archivepage       | html used for the archive page
+archiveitem       | snippet for each list item on archive page
+rollingpage       | html used for rolling page
+rollingitem       | snippet for each rolling item
+feed              | main xml for rss feed
+feeditem          | xml snippet for each entry in feed
+articlepage       | html for each article
+navbar            | sample template for mounts
 
 ## modules
 
-these have not been implemented yet, but modules are shellscripts that are called during the build process that can add extra features.
+modules are shellscripts that are called during the build process that can add extra features.
 
 here are some potential ideas for modules:
 - [ ] syntax highlight for code blocks
-- [ ] blog average time to read
+- [x] blog average time to read
 
 ## pinopress flavored markdown
 
@@ -37,9 +40,9 @@ pinopress articles are written in an enhanced version of markdown. specification
 
 `$SITEURL` - the SITEURL variable you set in the pinopress config
 
-`$USERVAR1` - global variable you can use however you want
+`$USERGLOBAL1` - global variable you can use however you want
 
-`$USERVAR2` - a second user defined global variable
+`$USERGLOBAL2` - a second user defined global variable
 
 ### article only
 
@@ -47,7 +50,25 @@ pinopress articles are written in an enhanced version of markdown. specification
 
 `$PUBLISHED_DATE` - the date/time the article was published, as set in the article header
 
+`$DESCRIPTION` - brief description of the blog post
+
+`$USERLOCAL1` - article specific variable you can use for whatever you want
+
+`$USERLOCAL2` - another user local variable
+
 ## mounts
 
-coming soon...
+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 -->
+```