README.md

   1 # pinopress
   2
   3 **pinopress** is a modular makefile based static blog generator. that means you run the build script once and every page is generated beforehand.
   4
   5 built in features include markdown generated blog articles, and a rss feed.
   6
   7 ## templates
   8
   9 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.
  10
  11 ## modules
  12
  13 these have not been implemented yet, but modules are shellscripts that are called during the build process that can add extra features.
  14
  15 here are some potential ideas for modules:
  16 - [ ] syntax highlight for code blocks
  17 - [ ] blog average time to read
  18
  19 ## pinopress flavored markdown
  20
  21 pinopress articles are written in an enhanced version of markdown. specification coming soon.
  22
  23 ## variables
  24
  25  **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:
  26
  27 ### global
  28
  29 `$SITEURL` - the SITEURL variable you set in the pinopress config
  30 `$USERVAR1` - global variable you can use however you want
  31 `$USERVAR2` - a second user defined global variable
  32
  33 ### article only
  34
  35 `$ARTICLE_TITLE` - title of article, as set in article header
  36 `$PUBLISHED_DATE` - the date/time the article was published, as set in the article header
  37
  38 ## mounts
  39
  40 coming soon...
  41