X-Git-Url: https://git.r.bdr.sh/rbdr/blog/blobdiff_plain/5f81d796fed4e4efbaf6dbed7d3c69481afddeb3..53812065cf124b6c1bc40fceec46f8c161033e29:/doc/README.md diff --git a/doc/README.md b/doc/README.md deleted file mode 100644 index 988e0e7..0000000 --- a/doc/README.md +++ /dev/null @@ -1,171 +0,0 @@ -## Classes - -
Generates the blog index page
-Generates an RSS feed XML file
-Generates the static assets required for the blog
-Generates a TXT version of the blog
-Promise.<undefined>
- * [.update(postLocation)](#Blog+update) â Promise.<undefined>
- * [.publish()](#Blog+publish) â Promise.<undefined>
- * [.publishArchive()](#Blog+publishArchive) â Promise.<undefined>
- * [.addRemote()](#Blog+addRemote) â Promise.<undefined>
- * [.removeRemote()](#Blog+removeRemote) â Promise.<undefined>
- * [.syncDown()](#Blog+syncDown) â Promise.<undefined>
- * [.syncUp()](#Blog+syncUp) â 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 | Blog.tConfiguration
| the initialization options to extend the instance |
-
-
-
-### blog.add(postLocation) â Promise.<undefined>
-Shifts the blog posts, adds the passed file 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 blog post file |
-
-
-
-### blog.update(postLocation) â Promise.<undefined>
-Update slot 0 with the passed gmi file, 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 blog post file |
-
-
-
-### 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
-
-
-### blog.publishArchive() â Promise.<undefined>
-Publishes the archive to a host using rsync. Currently assumes
-gemlog archive.
-
-**Kind**: instance method of [Blog
](#Blog)
-**Returns**: Promise.<undefined>
- empty promise, returns no value
-
-
-### blog.addRemote() â Promise.<undefined>
-Adds a remote
-
-**Kind**: instance method of [Blog
](#Blog)
-**Returns**: Promise.<undefined>
- empty promise, returns no value
-
-
-### blog.removeRemote() â Promise.<undefined>
-Removes a remote
-
-**Kind**: instance method of [Blog
](#Blog)
-**Returns**: Promise.<undefined>
- empty promise, returns no value
-
-
-### blog.syncDown() â Promise.<undefined>
-Pulls the posts and archive from the remote
-
-**Kind**: instance method of [Blog
](#Blog)
-**Returns**: Promise.<undefined>
- empty promise, returns no value
-
-
-### blog.syncUp() â Promise.<undefined>
-Pushes the posts and archive to the remote
-
-**Kind**: instance method of [Blog
](#Blog)
-**Returns**: Promise.<undefined>
- empty promise, returns no value
-
-
-## HTMLGenerator
-Generates the blog index page
-
-**Kind**: global variable
-
-| Param | Type | Description |
-| --- | --- | --- |
-| source | string
| the source directory |
-| target | string
| the target directory |
-| posts | Array.<Blog.tPost>
| the list of posts |
-
-
-
-## RSSGenerator
-Generates an RSS feed XML file
-
-**Kind**: global variable
-
-| Param | Type | Description |
-| --- | --- | --- |
-| source | string
| the source directory |
-| target | string
| the target directory |
-| posts | Array.<Blog.tPost>
| the list of posts |
-
-
-
-## StaticGenerator
-Generates the static assets required for the blog
-
-**Kind**: global variable
-
-| Param | Type | Description |
-| --- | --- | --- |
-| source | string
| the source directory |
-| target | string
| the target directory |
-| posts | Array.<Blog.tPost>
| the list of posts |
-
-
-
-## TXTGenerator
-Generates a TXT version of the blog
-
-**Kind**: global variable
-
-| Param | Type | Description |
-| --- | --- | --- |
-| source | string
| the source directory |
-| target | string
| the target directory |
-| posts | Array.<Blog.tPost>
| the list of posts |
-