pinosaur
/
pinopress.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
reorganized templates
[pinopress.git]
/
README.md
diff --git
a/README.md
b/README.md
index
e7fb04f
..
7ed0e9b
100644
(file)
--- 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
**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.
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
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 flavored markdown
@@
-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
`$SITEURL` - the SITEURL variable you set in the pinopress config
-`$USER
VAR
1` - global variable you can use however you want
+`$USER
GLOBAL
1` - global variable you can use however you want
-`$USER
VAR
2` - a second user defined global variable
+`$USER
GLOBAL
2` - a second user defined global variable
### article only
### article only
@@
-47,7
+48,9
@@
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
`$PUBLISHED_DATE` - the date/time the article was published, as set in the article header
-## mounts
+`$DESCRIPTION` - brief description of the blog post
-coming soon...
+`$USERLOCAL1` - article specific variable you can use for whatever you want
+
+`$USERLOCAL2` - another user local variable