# 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. **pinopress** makes extensive use of **gnu envsubst** so in each template, you can use variables that will be substituted in on build.
+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:
+
+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 |
## modules
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
pinopress articles are written in an enhanced version of markdown. specification coming soon.
+## variables
+
+ **pinopress** makes extensive use of **gnu envsubst** so in each template, you can use variables that will be substituted in on build. variables can be used in both templates and blog articles. Here's a list of some that you can use:
+
+### global
+
+`$SITEURL` - the SITEURL variable you set in the pinopress config
+
+`$USERGLOBAL1` - global variable you can use however you want
+
+`$USERGLOBAL2` - a second user defined global variable
+
+### article only
+
+`$ARTICLE_TITLE` - title of article, as set in article header
+
+`$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
+
