]> git.r.bdr.sh - rbdr/blog/blame - doc/README.md
Update dependencies + adapt code for them
[rbdr/blog] / doc / README.md
CommitLineData
d92ac8cc
BB
1<a name="Blog"></a>
2
3## Blog
4**Kind**: global class
5
6* [Blog](#Blog)
7 * [new Blog(config)](#new_Blog_new)
8 * [.add(postLocation)](#Blog+add) ⇒ <code>Promise.&lt;undefined&gt;</code>
9 * [.update(postLocation)](#Blog+update) ⇒ <code>Promise.&lt;undefined&gt;</code>
10 * [.publish()](#Blog+publish) ⇒ <code>Promise.&lt;undefined&gt;</code>
11
12<a name="new_Blog_new"></a>
13
14### new Blog(config)
15The Blog class is the blog generator, it's in charge of adding and
16updating posts, and handling the publishing.
17
18
19| Param | Type | Description |
20| --- | --- | --- |
21| config | <code>Potluck.tConfiguration</code> | the initialization options to extend the instance |
22
23<a name="Blog+add"></a>
24
25### blog.add(postLocation) ⇒ <code>Promise.&lt;undefined&gt;</code>
26Shifts the blog posts, adds the passed path to slot 0, and
27generates files.
28
29**Kind**: instance method of [<code>Blog</code>](#Blog)
30**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value
31
32| Param | Type | Description |
33| --- | --- | --- |
34| postLocation | <code>string</code> | the path to the directory containing the post structure |
35
36<a name="Blog+update"></a>
37
38### blog.update(postLocation) ⇒ <code>Promise.&lt;undefined&gt;</code>
39Adds the passed path to slot 0, and generates files.
40
41**Kind**: instance method of [<code>Blog</code>](#Blog)
42**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value
43
44| Param | Type | Description |
45| --- | --- | --- |
46| postLocation | <code>string</code> | the path to the directory containing the post structure |
47
48<a name="Blog+publish"></a>
49
50### blog.publish() ⇒ <code>Promise.&lt;undefined&gt;</code>
51Publishes the files to a static host.
52
53**Kind**: instance method of [<code>Blog</code>](#Blog)
54**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value