# node-novel-info

> mdconf module for node-novel

Latest version **3.0.18** (published 2024-02-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install node-novel-info
pnpm add node-novel-info
yarn add node-novel-info
bun add node-novel-info
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.18 |
| Published | 2024-02-03 |
| First published | 2018-01-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 14 |
| Unpacked size | 99.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | bluelovers |
| Maintainers | bluelovers |
| Keywords | config, info, json, markdown, md, mdconf, mdconfig, node-novel, novel, parse, stringify, txt |

## Links

- npm: https://www.npmjs.com/package/node-novel-info
- Repository: https://github.com/bluelovers/ws-node-novel
- Homepage: https://github.com/bluelovers/ws-node-novel/tree/master/packages/node-novel-info#readme
- Issues: https://github.com/bluelovers/ws-node-novel/issues
- npm.io page: https://npm.io/package/node-novel-info

## Dependencies (14)

- [chai](https://npm.io/package/chai.md) <5 >=4.4.1
- [tslib](https://npm.io/package/tslib.md) ^2
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [moment](https://npm.io/package/moment.md) ^2.30.1
- [hex-lib](https://npm.io/package/hex-lib.md) ^1.0.2
- [mdconf2](https://npm.io/package/mdconf2.md) ^2.0.19
- [env-bool](https://npm.io/package/env-bool.md) ^2.0.1
- [jsdom-url](https://npm.io/package/jsdom-url.md) ^3.0.1
- [crlf-normalize](https://npm.io/package/crlf-normalize.md) ^1.0.20
- [deepmerge-plus](https://npm.io/package/deepmerge-plus.md) ^3.0.2
- [is-plain-object](https://npm.io/package/is-plain-object.md) ^5.0.0
- [lodash-decorators](https://npm.io/package/lodash-decorators.md) ^6.0.1
- [sort-object-keys2](https://npm.io/package/sort-object-keys2.md) ^3.0.5
- [array-hyper-unique](https://npm.io/package/array-hyper-unique.md) ^2.1.4

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 3.0.18 (latest) — 2024-02-03
- 3.0.17 — 2024-01-29
- 3.0.16 — 2022-11-04
- 3.0.15 — 2022-05-16
- 3.0.14 — 2021-07-08
- 3.0.13 — 2021-02-12
- 3.0.11 — 2020-08-13
- 3.0.10 — 2020-07-19
- 3.0.9 — 2020-06-30
- 3.0.7 — 2020-06-20
- 3.0.5 — 2020-06-09
- 3.0.3 — 2020-06-08
- 3.0.2 — 2020-06-05
- 3.0.1 — 2020-03-24
- 3.0.0 — 2020-01-15
- … 48 more at https://npm.io/package/node-novel-info/versions

## README

# node-novel-info

> mdconf module for node-novel

`npm install node-novel-info`

## demo

[README.md](test/res/README.md)

```
const novelInfo = require('node-novel-info');
import * as novelInfo from 'node-novel-info';
import novelInfo from 'node-novel-info';
```

### mdconf_parse

<!-- js
var novelInfo = require('.');
var fs = require('fs-extra');
var Mdconf = novelInfo;
-->

```js
fs.readFile('./test/res/README.md')
	.then(function (buf)
	{
		return novelInfo.parse(buf, {
			//chk: false
		});
	})
	.then(function (conf)
	{
		console.log(conf);
		
		return conf;
	})
;
```

#### output

```
{ novel: 
   { title: '自卫队三部曲',
     author: '有川浩',
     source: 'http://www.wenku8.com/modules/article/reader.php?aid=350',
     publisher: '富士见文库',
     cover: 'http://img.wenku8.com/image/0/350/350s.jpg',
     date: '2011-06-22T00:00:00+08:00',
     status: '已完成',
     preface: '故事背景架构在近未来（或可称为平行世界）的曰本。\n某天，直径五百公尺的白色陨石状物体以迅雷不及掩耳之势坠落在地球上。\n同一时间，发生了人类变化成盐柱的诡异现象（一般称之为“盐害”），光是曰本地区的死亡人数便估计多达八千万人。文明社会在一瞬间崩溃，劫后余生的人们逃到农村，过着自给自足的贫乏生活……',
     tags: [ 'node-novel', 'wenku8' ] },
  options: { textlayout: { allow_lf2: 'true' } } }
```

### Mdconf.stringify

```js
var moment = require("moment");
console.log(novelInfo.stringify({
	novel: {
		test: true,
	},

	options: {

		textlayout: {
			lf: true,
		},

		data: moment(),

	}
}));
```

#### output

```markdown
#novel

- test: true

#options

- data: 2018-02-04T02:48:24+08:00

##textlayout

- lf: true
```

## links

- [node-novel-info](https://www.npmjs.com/package/node-novel-info)
- [mdconf2](https://www.npmjs.com/package/mdconf2)
- [mdconf-stringify](https://www.npmjs.com/package/mdconf-stringify)

---
_Source: https://npm.io/package/node-novel-info · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
