diff options
| author | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2024-02-04 23:25:20 +0100 |
|---|---|---|
| committer | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2024-02-04 23:25:20 +0100 |
| commit | 97b339325ac4d5a7cf56f2b87fcb93e8887e50a1 (patch) | |
| tree | 0d1b73ce8b3f723afde8e4e0427b77e745a2824a /doc | |
| parent | a9c02cac1fde01ac28dc1241d1e63f85a1ff03a2 (diff) | |
Update deps, fix broken update5.0.1
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 127 |
1 files changed, 122 insertions, 5 deletions
diff --git a/doc/README.md b/doc/README.md index 4e9e131..988e0e7 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,3 +1,27 @@ +## Classes + +<dl> +<dt><a href="#Blog">Blog</a></dt> +<dd></dd> +</dl> + +## Members + +<dl> +<dt><a href="#HTMLGenerator">HTMLGenerator</a></dt> +<dd><p>Generates the blog index page</p> +</dd> +<dt><a href="#RSSGenerator">RSSGenerator</a></dt> +<dd><p>Generates an RSS feed XML file</p> +</dd> +<dt><a href="#StaticGenerator">StaticGenerator</a></dt> +<dd><p>Generates the static assets required for the blog</p> +</dd> +<dt><a href="#TXTGenerator">TXTGenerator</a></dt> +<dd><p>Generates a TXT version of the blog</p> +</dd> +</dl> + <a name="Blog"></a> ## Blog @@ -8,6 +32,11 @@ * [.add(postLocation)](#Blog+add) ⇒ <code>Promise.<undefined></code> * [.update(postLocation)](#Blog+update) ⇒ <code>Promise.<undefined></code> * [.publish()](#Blog+publish) ⇒ <code>Promise.<undefined></code> + * [.publishArchive()](#Blog+publishArchive) ⇒ <code>Promise.<undefined></code> + * [.addRemote()](#Blog+addRemote) ⇒ <code>Promise.<undefined></code> + * [.removeRemote()](#Blog+removeRemote) ⇒ <code>Promise.<undefined></code> + * [.syncDown()](#Blog+syncDown) ⇒ <code>Promise.<undefined></code> + * [.syncUp()](#Blog+syncUp) ⇒ <code>Promise.<undefined></code> <a name="new_Blog_new"></a> @@ -18,12 +47,12 @@ updating posts, and handling the publishing. | Param | Type | Description | | --- | --- | --- | -| config | <code>Potluck.tConfiguration</code> | the initialization options to extend the instance | +| config | <code>Blog.tConfiguration</code> | the initialization options to extend the instance | <a name="Blog+add"></a> ### blog.add(postLocation) ⇒ <code>Promise.<undefined></code> -Shifts the blog posts, adds the passed path to slot 0, and +Shifts the blog posts, adds the passed file to slot 0, and generates files. **Kind**: instance method of [<code>Blog</code>](#Blog) @@ -31,19 +60,19 @@ generates files. | Param | Type | Description | | --- | --- | --- | -| postLocation | <code>string</code> | the path to the directory containing the post structure | +| postLocation | <code>string</code> | the path to the blog post file | <a name="Blog+update"></a> ### blog.update(postLocation) ⇒ <code>Promise.<undefined></code> -Adds the passed path to slot 0, and generates files. +Update slot 0 with the passed gmi file, and generates files. **Kind**: instance method of [<code>Blog</code>](#Blog) **Returns**: <code>Promise.<undefined></code> - empty promise, returns no value | Param | Type | Description | | --- | --- | --- | -| postLocation | <code>string</code> | the path to the directory containing the post structure | +| postLocation | <code>string</code> | the path to the blog post file | <a name="Blog+publish"></a> @@ -52,3 +81,91 @@ Publishes the files to a static host. **Kind**: instance method of [<code>Blog</code>](#Blog) **Returns**: <code>Promise.<undefined></code> - empty promise, returns no value +<a name="Blog+publishArchive"></a> + +### blog.publishArchive() ⇒ <code>Promise.<undefined></code> +Publishes the archive to a host using rsync. Currently assumes +gemlog archive. + +**Kind**: instance method of [<code>Blog</code>](#Blog) +**Returns**: <code>Promise.<undefined></code> - empty promise, returns no value +<a name="Blog+addRemote"></a> + +### blog.addRemote() ⇒ <code>Promise.<undefined></code> +Adds a remote + +**Kind**: instance method of [<code>Blog</code>](#Blog) +**Returns**: <code>Promise.<undefined></code> - empty promise, returns no value +<a name="Blog+removeRemote"></a> + +### blog.removeRemote() ⇒ <code>Promise.<undefined></code> +Removes a remote + +**Kind**: instance method of [<code>Blog</code>](#Blog) +**Returns**: <code>Promise.<undefined></code> - empty promise, returns no value +<a name="Blog+syncDown"></a> + +### blog.syncDown() ⇒ <code>Promise.<undefined></code> +Pulls the posts and archive from the remote + +**Kind**: instance method of [<code>Blog</code>](#Blog) +**Returns**: <code>Promise.<undefined></code> - empty promise, returns no value +<a name="Blog+syncUp"></a> + +### blog.syncUp() ⇒ <code>Promise.<undefined></code> +Pushes the posts and archive to the remote + +**Kind**: instance method of [<code>Blog</code>](#Blog) +**Returns**: <code>Promise.<undefined></code> - empty promise, returns no value +<a name="HTMLGenerator"></a> + +## HTMLGenerator +Generates the blog index page + +**Kind**: global variable + +| Param | Type | Description | +| --- | --- | --- | +| source | <code>string</code> | the source directory | +| target | <code>string</code> | the target directory | +| posts | <code>Array.<Blog.tPost></code> | the list of posts | + +<a name="RSSGenerator"></a> + +## RSSGenerator +Generates an RSS feed XML file + +**Kind**: global variable + +| Param | Type | Description | +| --- | --- | --- | +| source | <code>string</code> | the source directory | +| target | <code>string</code> | the target directory | +| posts | <code>Array.<Blog.tPost></code> | the list of posts | + +<a name="StaticGenerator"></a> + +## StaticGenerator +Generates the static assets required for the blog + +**Kind**: global variable + +| Param | Type | Description | +| --- | --- | --- | +| source | <code>string</code> | the source directory | +| target | <code>string</code> | the target directory | +| posts | <code>Array.<Blog.tPost></code> | the list of posts | + +<a name="TXTGenerator"></a> + +## TXTGenerator +Generates a TXT version of the blog + +**Kind**: global variable + +| Param | Type | Description | +| --- | --- | --- | +| source | <code>string</code> | the source directory | +| target | <code>string</code> | the target directory | +| posts | <code>Array.<Blog.tPost></code> | the list of posts | + |