X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=README.md;h=b4e5b417f30e4752fc70e60320c9650655d80cd0;hb=394bc43d24de087865fa4eed1920411c1a6d7ebd;hp=e7fb04fdaafa46bae058e015c41af4a3fbf83e5f;hpb=c2a180be93daf0ae77953d548c5bd658818452a3;p=pinopress.git diff --git a/README.md b/README.md index e7fb04f..b4e5b41 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # 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. @@ -37,9 +38,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 +48,13 @@ 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... +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.