spec: expose readMetadata

[akabekobeko]

Goals

Expose readMetadata so that Vivliostyle CLI etc. can read metadata with type information.

Prior Art

import { readMetadata } from '@vivliostyle/vfm/plugins/metadata'

Discussion

#98

[akabekobeko]

現時点の Vivliostyle CLI は独自に Markdown の Frontmatter を処理して theme と title を読み込んでいる。しかし Frontmatter 構成は VFM に隠蔽されるもので外部プログラムからは VFM の API を通して取得するようにしたほうが好ましい。

既に VFM v1.0.0-alpha.23 で theme の位置がルートから vfm.theme に移動されている。

以上を踏まえ VFM 自身がメタデータ読み込みのために実装した readMetadata を公開 API とする。index.ts から export するようにすればよいはず。

[akabekobeko]

#108 にて対応したので close する。本件は v1.0.0-alpha.24 に反映予定。