]> git.r.bdr.sh - rbdr/blog/commitdiff
Remove unused JS code and docs
authorRuben Beltran del Rio <redacted>
Sat, 24 Feb 2024 23:20:32 +0000 (23:20 +0000)
committerRuben Beltran del Rio <redacted>
Sat, 24 Feb 2024 23:20:32 +0000 (23:20 +0000)
doc/README.md [deleted file]
lib/constants.js [deleted file]

diff --git a/doc/README.md b/doc/README.md
deleted file mode 100644 (file)
index 988e0e7..0000000
+++ /dev/null
@@ -1,171 +0,0 @@
-## 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
-**Kind**: global class  
-
-* [Blog](#Blog)
-    * [new Blog(config)](#new_Blog_new)
-    * [.add(postLocation)](#Blog+add) ⇒ <code>Promise.&lt;undefined&gt;</code>
-    * [.update(postLocation)](#Blog+update) ⇒ <code>Promise.&lt;undefined&gt;</code>
-    * [.publish()](#Blog+publish) ⇒ <code>Promise.&lt;undefined&gt;</code>
-    * [.publishArchive()](#Blog+publishArchive) ⇒ <code>Promise.&lt;undefined&gt;</code>
-    * [.addRemote()](#Blog+addRemote) ⇒ <code>Promise.&lt;undefined&gt;</code>
-    * [.removeRemote()](#Blog+removeRemote) ⇒ <code>Promise.&lt;undefined&gt;</code>
-    * [.syncDown()](#Blog+syncDown) ⇒ <code>Promise.&lt;undefined&gt;</code>
-    * [.syncUp()](#Blog+syncUp) ⇒ <code>Promise.&lt;undefined&gt;</code>
-
-<a name="new_Blog_new"></a>
-
-### 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 | <code>Blog.tConfiguration</code> | the initialization options to extend the instance |
-
-<a name="Blog+add"></a>
-
-### blog.add(postLocation) ⇒ <code>Promise.&lt;undefined&gt;</code>
-Shifts the blog posts, adds the passed file to slot 0, and
-generates files.
-
-**Kind**: instance method of [<code>Blog</code>](#Blog)  
-**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| postLocation | <code>string</code> | the path to the blog post file |
-
-<a name="Blog+update"></a>
-
-### blog.update(postLocation) ⇒ <code>Promise.&lt;undefined&gt;</code>
-Update slot 0 with the passed gmi file, and generates files.
-
-**Kind**: instance method of [<code>Blog</code>](#Blog)  
-**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| postLocation | <code>string</code> | the path to the blog post file |
-
-<a name="Blog+publish"></a>
-
-### blog.publish() ⇒ <code>Promise.&lt;undefined&gt;</code>
-Publishes the files to a static host.
-
-**Kind**: instance method of [<code>Blog</code>](#Blog)  
-**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
-<a name="Blog+publishArchive"></a>
-
-### blog.publishArchive() ⇒ <code>Promise.&lt;undefined&gt;</code>
-Publishes the archive to a host using rsync. Currently assumes
-gemlog archive.
-
-**Kind**: instance method of [<code>Blog</code>](#Blog)  
-**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
-<a name="Blog+addRemote"></a>
-
-### blog.addRemote() ⇒ <code>Promise.&lt;undefined&gt;</code>
-Adds a remote
-
-**Kind**: instance method of [<code>Blog</code>](#Blog)  
-**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
-<a name="Blog+removeRemote"></a>
-
-### blog.removeRemote() ⇒ <code>Promise.&lt;undefined&gt;</code>
-Removes a remote
-
-**Kind**: instance method of [<code>Blog</code>](#Blog)  
-**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
-<a name="Blog+syncDown"></a>
-
-### blog.syncDown() ⇒ <code>Promise.&lt;undefined&gt;</code>
-Pulls the posts and archive from the remote
-
-**Kind**: instance method of [<code>Blog</code>](#Blog)  
-**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
-<a name="Blog+syncUp"></a>
-
-### blog.syncUp() ⇒ <code>Promise.&lt;undefined&gt;</code>
-Pushes the posts and archive to the remote
-
-**Kind**: instance method of [<code>Blog</code>](#Blog)  
-**Returns**: <code>Promise.&lt;undefined&gt;</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.&lt;Blog.tPost&gt;</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.&lt;Blog.tPost&gt;</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.&lt;Blog.tPost&gt;</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.&lt;Blog.tPost&gt;</code> | the list of posts |
-
diff --git a/lib/constants.js b/lib/constants.js
deleted file mode 100644 (file)
index 2142718..0000000
+++ /dev/null
@@ -1 +0,0 @@
-export const kFileNotFoundError = 'ENOENT';