Skip to content
This repository
Browse code

Made README file a markdown file

- Text was largely formatted as markdown already
  • Loading branch information...
commit 3aa91e6d8b854412637921866487e49f7ab3e2b7 1 parent 9cbf086
Matthew Weier O'Phinney authored March 14, 2012
2  .vimproject
... ...
@@ -1,6 +1,6 @@
1 1
 mustache=/home/matthew/git/phly_mustache CD=. filter="*.php *.html *.xml *.txt" {
2 2
  LICENSE
3  
- README.txt
  3
+ README.md
4 4
  TODO
5 5
  library=library {
6 6
   Phly=Phly {
71  README.txt → README.md
Source Rendered
@@ -5,45 +5,46 @@ for PHP 5.3+. It conforms to the principles of mustache, and allows for
5 5
 extension of the format via pragmas.
6 6
 
7 7
 At this time, it has support for the following:
8  
- - Renders string templates
9  
- - Renders file templates
10  
- - Can use object properties for substitutions
11  
- - Can use method return value for substitutions
12  
- - Template may use conditionals
13  
- - Conditional is skipped if value is false
14  
- - Conditional is skipped if value is empty
15  
- - Template iterates arrays
16  
- - Template iterates traversable objects
17  
- - Higher order sections render inside out
18  
- - Template will dereference nested arrays
19  
- - Template will dereference nested objects
20  
- - Inverted sections render on empty values
21  
- - Renders partials
22  
- - Allows aliasing partials
23  
- - Escapes standard characters
24  
- - Triple mustaches prevent escaping
25  
- - Honors implicit iterator pragma
26  
- - Allows setting alternate template suffix
27  
- - Strips comments from rendered output
28  
- - Allows specifying alternate delimiters
29  
- - Alternate delimiters set in section only apply to that section
30  
- - Alternate delimiters apply to child sections
31  
- - Alternate delimiters do not carry to partials
32  
- - Pragmas are section specific
33  
- - Pragmas do not extend to partials
34  
- - Handles recursive partials
35  
- - Lexer strips unwanted whitespace from tokens
  8
+
  9
+- Renders string templates
  10
+- Renders file templates
  11
+- Can use object properties for substitutions
  12
+- Can use method return value for substitutions
  13
+- Template may use conditionals
  14
+- Conditional is skipped if value is false
  15
+- Conditional is skipped if value is empty
  16
+- Template iterates arrays
  17
+- Template iterates traversable objects
  18
+- Higher order sections render inside out
  19
+- Template will dereference nested arrays
  20
+- Template will dereference nested objects
  21
+- Inverted sections render on empty values
  22
+- Renders partials
  23
+- Allows aliasing partials
  24
+- Escapes standard characters
  25
+- Triple mustaches prevent escaping
  26
+- Honors implicit iterator pragma
  27
+- Allows setting alternate template suffix
  28
+- Strips comments from rendered output
  29
+- Allows specifying alternate delimiters
  30
+- Alternate delimiters set in section only apply to that section
  31
+- Alternate delimiters apply to child sections
  32
+- Alternate delimiters do not carry to partials
  33
+- Pragmas are section specific
  34
+- Pragmas do not extend to partials
  35
+- Handles recursive partials
  36
+- Lexer strips unwanted whitespace from tokens
36 37
 
37 38
 Architecture
38 39
 ============
39 40
 Phly\Mustache consists of four primary classes:
40 41
 
41  
- - Lexer: tokenizes a template
42  
- - Renderer: renders a list of tokens, using substitions provided via a view
43  
- - Pragma: interface for pragmas, which may modify how tokens are handled
44  
- - Mustache: facade/gateway class. Tokenizes and renders templates, caches
45  
-   tokens, provides partial aliasing, and acts as primary interface for
46  
-   end-users.
  42
+- Lexer: tokenizes a template
  43
+- Renderer: renders a list of tokens, using substitions provided via a view
  44
+- Pragma: interface for pragmas, which may modify how tokens are handled
  45
+- Mustache: facade/gateway class. Tokenizes and renders templates, caches
  46
+  tokens, provides partial aliasing, and acts as primary interface for
  47
+  end-users.
47 48
 
48 49
 Usage
49 50
 =====
@@ -107,7 +108,7 @@ Autoloading
107 108
 ===========
108 109
 phly_mustache follows the PSR-0 standard for class naming conventions, meaning
109 110
 any PSR-0-compliant class loader will work. To simplify things out of the box,
110  
-the component contains an "_autoload.php" file which will register an autoloader
  111
+the component contains an "\_autoload.php" file which will register an autoloader
111 112
 for the phly_mustache component with spl_autoload. You can simply include that
112 113
 file, and start using phly_mustache.
113 114
 

0 notes on commit 3aa91e6

Please sign in to comment.
Something went wrong with that request. Please try again.