diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 4 insertions, 3 deletions
@@ -24,7 +24,7 @@ testbak/ ``` where `.frag` and `.html` are equivalent, and invoke loom: ``` -loom -r {root path} -o {output path} [-s {static path}] +loom -r {root path} -o {output path} -e {header template} -f {footer template} [-s {static path}] ``` Each fragment will generate a html page in the output directory in the same structure. The generated page will be composed of a header and footer with the text of the fragment placed in `<main>`. The header also conatins the title of the page, which can be specified by placing a line @@ -33,7 +33,9 @@ Each fragment will generate a html page in the output directory in the same stru ``` on the first line of the fragment file. The title cannot contain newlines or the vertical bar character. If unspecified it will default to the basename of the fragment file. -The header will also include a `<nav>` which produces a tree featuring the spine from the current page to the root, all descendants of the current page, and any sibling or sibling of an ancestor of the current page. The tree is sorted by file name, should you wish for the tree order and page title to differ. +The footer should be a simple html file concatenated to all pages. The header is a template where the string "%t" is replaced by the page title and "%n" by the nav bar contents (not including the nav tag itself). + +The generated `<nav>` produces a tree featuring the spine from the current page to the root, all descendants of the current page, and any sibling or sibling of an ancestor of the current page. The tree is sorted by file name, should you wish for the tree order and page title to differ. A static path, if specified, is simply recursively copied into the output directory after generation occurs. @@ -43,6 +45,5 @@ A static path, if specified, is simply recursively copied into the output direct - Requires a functional Haskell ecosystem ## Remaining work -- Support for header and footer as args/files like node. Mostly a matter of picking a placeholder token for the title and nav in the header - Better error messages - More safety checks. Particularly checking that every generated link is either an absolute path to an extant file or is a proper link out with https and all. |