https://github.com/cdrubin/pashlicks2
https://github.com/cdrubin/pashlicks2
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cdrubin/pashlicks2
- Owner: cdrubin
- Created: 2013-03-21T21:12:21.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-04-17T14:17:21.000Z (about 11 years ago)
- Last Synced: 2025-02-05T17:44:05.144Z (4 months ago)
- Language: Lua
- Size: 211 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Pashlicks2
=======
Pashlicks2 is a text processor that allows lua to be executed in
the context of page generation. Developed as a static website
generator she claims to be simple to extend.
Pashlicks2 expects to be at the foot (root) of your site. She adds
the execution of `_dir.lua` to the environment of the contents of
a directory.
Files and directories that begin with `_` or `.` are ignored.
She understands three kinds of tags inside source files :
1. Code
``` lua
[% for i = 1,5 do %]
[% end %]
```
2. Value
``` lua
[% for i = 1,5 do %]
[% end %]
```
3. Include
``` lua
[( "menu.html" )]
```
She could certainly process any filetype but we usually have her
chew on HTML template files.
A common need when using Pashlicks as a static site generator
is the use of a _layout_ or _template_ inside which to embed the
content of a page. Specifying a layout can be done in a `_dir.lua`
file so that all pages in that directory and any of its child directories
use a particular layout. Specifying the layout template can of course
also be done inside the page itself.
```lua
page.layout = '_layouts/site.html'
site.keywords = 'Dog-run'
```
**avoid** doing something like the following :
```lua
page = { layout = '_layouts/site.html' }
```
because you will be clobbering the page table contents created elsewhere.
When specifying a layout the page is rendered to the variable `page.content`.
So with a layout like this :
```
_dir.lua
_layouts/
site.html
_snippets/
menu.html
index.html
pashlicks.lua
```
we could have :
```
--- _dir.lua
page.layout = '_layouts/site.html'
--- _layouts/site.html
[= page.title =]
[= page.content =]
--- index.html
[% page.title = 'The truth about Pashlicks2' %]
Pashlicks loves her sisters Josie and Marmite
```
to produce an index.html file containing :
```html
The truth about Pashlicks2
Pashlicks loves her sisters Josie and Marmite
```
To avoid very long pages that do not share content with other pages **page parts**
can be used. These page part files are identified by the name of the page they are
related to preceeded by double underscores, followed by a dot and the
name of the part. These sections are rendered within the context of the
named page. For 'carousel' and 'featured' parts of the events page we would
have :
```
--- __events.carousel.html
--- __events.featured.html
Featured!
--- events.html
[%
page.layout = '_layouts/site.html'
page.title = 'Events'
%]
[= page.parts['carousel.html'] =]
[= page.parts['featured.html'] =]
```
An example of some customization is available in the included
[_dir.lua](https://github.com/cdrubin/pashlicks2/blob/master/_dir.lua).
When this file is placed at the root of the site Pashlicks makes sure that
all pages have these values and functions available in their environment.
Every page has some *special* variables injected into its environment:
```lua
page.file -- filename of file being processed
page.directory -- directory of the file being processed
page.path -- path to file from root of site
page.level -- level in the tree at which this page sits
site.tree -- tree of site
```
Calling Pashlicks2 should be as simple as :
```bash
lua pashlicks2.lua _output
```