diff options
Diffstat (limited to 'generator/scanner.js')
| -rw-r--r-- | generator/scanner.js | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/generator/scanner.js b/generator/scanner.js index c8c1069..a1630d1 100644 --- a/generator/scanner.js +++ b/generator/scanner.js @@ -1,5 +1,15 @@ //Copyright Chris Xiong 2018 //License: Expat (MIT) +/* Returns all scanned posts in an array in the following format: + * { + * file: String = file name of post (excluding the .txt extension) + * title: String = title extracted from the post + * date: String = post date extracted from the post (expected to be an ISO8601 full-date string, with optional post-status suffix) + * tags: String = comma-separated list of tags + * mdate: Number = source last modification time in msec since epoch + * needsupdate: boolean = true if post needs re-rendering + * } + */ module.exports={ scan:function(s,d){return _scan(s,d);}, build_list_index:function(){return _build_list_index();} |