X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=2a202a72efdc527efab8c8a6be5d0c47b96bf0c2;hb=9ee898ef29fb76b04a2236ea8d7749ad6d962229;hp=4328dcb627cce3210cdf6771dd9421ba52be0b36;hpb=ae8408af2f6cac8cb64ff24aa1f2fe2c2255bf63;p=pinopress.git diff --git a/README.md b/README.md index 4328dcb..2a202a7 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. @@ -23,7 +24,7 @@ these have not been implemented yet, but modules are shellscripts that are calle 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 @@ -55,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: +``` + +``` +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: +``` + + + + +```