X-Git-Url: https://git.r.bdr.sh/rbdr/blog/blobdiff_plain/d92ac8ccf6516011bc40bff2b17ef0d0d766f9de..53812065cf124b6c1bc40fceec46f8c161033e29:/doc/README.md diff --git a/doc/README.md b/doc/README.md deleted file mode 100644 index 4e9e131..0000000 --- a/doc/README.md +++ /dev/null @@ -1,54 +0,0 @@ - - -## Blog -**Kind**: global class - -* [Blog](#Blog) - * [new Blog(config)](#new_Blog_new) - * [.add(postLocation)](#Blog+add) ⇒ Promise.<undefined> - * [.update(postLocation)](#Blog+update) ⇒ Promise.<undefined> - * [.publish()](#Blog+publish) ⇒ Promise.<undefined> - - - -### new Blog(config) -The Blog class is the blog generator, it's in charge of adding and -updating posts, and handling the publishing. - - -| Param | Type | Description | -| --- | --- | --- | -| config | Potluck.tConfiguration | the initialization options to extend the instance | - - - -### blog.add(postLocation) ⇒ Promise.<undefined> -Shifts the blog posts, adds the passed path to slot 0, and -generates files. - -**Kind**: instance method of [Blog](#Blog) -**Returns**: Promise.<undefined> - empty promise, returns no value - -| Param | Type | Description | -| --- | --- | --- | -| postLocation | string | the path to the directory containing the post structure | - - - -### blog.update(postLocation) ⇒ Promise.<undefined> -Adds the passed path to slot 0, and generates files. - -**Kind**: instance method of [Blog](#Blog) -**Returns**: Promise.<undefined> - empty promise, returns no value - -| Param | Type | Description | -| --- | --- | --- | -| postLocation | string | the path to the directory containing the post structure | - - - -### blog.publish() ⇒ Promise.<undefined> -Publishes the files to a static host. - -**Kind**: instance method of [Blog](#Blog) -**Returns**: Promise.<undefined> - empty promise, returns no value