Skip to content

Commit 6849991

Browse files
committed
Some minimal docs on the build-pages task and its @partial and @Placeholder handlers
1 parent 50cf349 commit 6849991

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,43 @@
22

33
A collection of tasks for building the jQuery websites
44

5+
## build-pages
6+
7+
This multi-task takes a list of html files, copies them to `[wordpress.dir]/posts/page`, processes @partial entries and highlights the syntax in each.
8+
9+
### @partial
10+
11+
Usage:
12+
13+
```html
14+
<pre><code data-linenum>@partial(resources/code-sample.html)</code></pre>
15+
```
16+
17+
Where `resources/code-sample.html` is relative path in the current directory. That html file will be inserted, escaped and highlighted.
18+
19+
### @placeholder
20+
21+
Inside markup included with @partial you can mark sections of code as @placeholder code, to be excluded from the inserted code, replaced with a html comment.
22+
23+
Usage:
24+
25+
```html
26+
regular markup will show up here
27+
<!-- @placeholder-start(more markup) -->
28+
this will be replaced
29+
<!-- @placeholder-end -->
30+
other content
31+
```
32+
33+
That will result in:
34+
35+
36+
```html
37+
regular markup will show up here
38+
<!-- more markup -->
39+
other content
40+
```
41+
542
## License
643
Copyright (c) 2012 Jörn Zaefferer
744
Licensed under the MIT license.

0 commit comments

Comments
 (0)