# chlog-to-html-list

> Changelog to html list.

Latest version **0.0.4** (published 2020-04-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install chlog-to-html-list
pnpm add chlog-to-html-list
yarn add chlog-to-html-list
bun add chlog-to-html-list
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2020-04-18 |
| First published | 2020-04-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 30.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | AC34 |
| Maintainers | ac34 |
| Keywords | changelog, html, list, ul, ol |

## Links

- npm: https://www.npmjs.com/package/chlog-to-html-list
- Repository: https://github.com/AC34/npm-chlog-to-html-list
- Homepage: https://github.com/AC34/npm-chlog-to-html-list#readme
- Issues: https://github.com/AC34/npm-chlog-to-html-list/issues
- npm.io page: https://npm.io/package/chlog-to-html-list

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 0.0.4 (latest) — 2020-04-18
- 0.0.3 — 2020-04-18
- 0.0.2 — 2020-04-18
- 0.0.1 — 2020-04-17
- 0.0.0 — 2020-04-16

## README

# npm-chlog-to-html-list
[Changelog](https://keepachangelog.com/) to html list, for embedding it to your html.
## Announcements
Preparing, don't use yet.
## Requirements
 - [Node.js](https://nodejs.org/)
 - [npm](https://www.npmjs.com/)
## Installation

Install it as devDependencies.
```
npm install --save-dev npm-chlog-to-html-list
```
## Usage
<ol>
  <li>
    <p>Create a Node.js file, require the module.(No need to Instantiate)</p>
  </li>
  <li>
    <p>Call getList method.</p>
    <ol>
      <li><p>Set option as an object "{}".</p></li>
      <li><p>Give options as key-value pairs.</p></li>
    </ol>
  </li>
  <li>
    <p>Run the script and use the acquired list for your html pages.</p>
  </li>
</ol>

### Blueprint
A very simple blueprint of yoru script may be as below:
```
 //load the module
 var lister = require("chlog-to-html-list");

 //give options as an object
 var list = lister.getList({
    changelog_path:"path_to_changelog.md" 
 });

 //embed the generated list to your html page now.
```
 
## Options
Available options are as follows:

#### General options
|        key        |  type   |    default     | description                                            |
| :---: | :---: | :---: |:--- |
|verbose|boolean|true|Whether to show console outputs during the process.|

#### Options for Paths
|        key        |  type   |    default     | description                                            |
| :---: | :---: | :---: |:--- |
|changelog_path|string|"<span>CHANGELOG.md</span>"|Path to the changelog file(from the root path).|
|package_json_path|string|"package.json"|Path to the package.json file(from the root path).|

#### Options for html outputs
|        key        |  type   |    default     | description                                            |
| :---: | :---: | :---: |:--- |
|list_id|string|"changelog-list"|The id of the list(list_type).|
|list_class|string|"changelog-list"|The class name of the list(list_type).|
|list_type|string|"ul"|The list type of the most outer element of the output html.|

## Seeing log
By default the option "verbose" is set to true.
You could also get logs as an array so that you can store them if you want to.
To get the log, just call the "getLog()" method.
Note that an empty log will be returnedd when you call "getLog()" before calling "getList" method.
example:
```
var logs = lister.getLog();
```
## Roadmap
Everything should be fine by 1.0.0.
No further development is being planned.

There can be some updates related to:
 - dependency updates
 - language udpates
 - updates on changelog schemes.


## Changes
<ul id="changelog-list" class="changelog-list"><li><dl><dt>0.0.4</dt>
<dt> 2020-04-18</dt>
<dt>Changed</dt>
</dl>
</li>
<li><dl><dt>0.0.3</dt>
<dt> 2020-04-18</dt>
<dt>Changed</dt>
<dd>preferGlobal set to false</dd>
<dd>"getlist unsuccessfully ended" message bug fix.</dd>
</dl>
</li>
<li><dl><dt>0.0.2</dt>
<dt> 2020-04-18</dt>
<dt>Added</dt>
<dd>LICENSE file</dd>
<dt>Changed</dt>
<dd>removing unnecessary files</dd>
<dd>typo fixes on file names</dd>
<dd>readme update</dd>
</dl>
</li>
<li><dl><dt>0.0.1</dt>
<dt></dt>
<dt>Added</dt>
<dd>added this CHANGELOG.md</dd>
<dd>class option of html</dd>
<dt>Changed</dt>
<dd>changing package description</dd>
<dd>getList can now take changelog_path as absolute path</dd>
<dd>some parsing bug fixes</dd>
<dd>some typo fixes</dd>
</dl>
</li>
<li><dl><dt>0.0.0</dt>
<dt></dt>
<dt>Changed</dt>
<dd>initial commit</dd>
</dl>
</li>
</ul>

---
_Source: https://npm.io/package/chlog-to-html-list · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._