@jaybeeuu/compost
TypeScript icon, indicating that this package has built-in type declarations

0.2.3 • Public • Published

compost

npm

A CLI took that compiles markdown files and metadata json into HTML and a manifest of posts.

It makes use of marked and prism, and uses yargs to provide the CLI.

Usage

This package provides a node executable so you can run it from the command line. To see the options available run:

compost --help

options

| Options | Description | Type | Default | | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | --------------- | ------- | | --version | Show version number | boolean | | | -r, --hrefRoot | The root path to apply when compiling hrefs (e.g. links). | string | "/" | | -a, --additionalWatchPaths | Paths other than --source-dir to watch when in watch mode. | array | | | -u, --includeUnpublished | Whether or not to compile posts not marked as published in their metadata.json file. | boolean | false | | -m, --manifestFileName | The nam of the output JSON manifest file. | string | "manifest.json" | | --codeLineNumbers | Include tags and classes in code blocks that can be styled to show line numbers with the Prism line number styles. | boolean | false | | --oldManifestLocator | The path or URL of the old manifest. If none is given then the output-dir and manifest-file-name options will be used to infer the location. If this option is given and no manifest is found compost will fail. | array | | | -o, --outputDir | The directory into which the compiled files should be written. | string | | "./lib" | | --removeH1 | Indicates whether the process will remove H1 (#) headings. Useful if you will render that with a custom heading in your page. | boolean | false | | --requireOldManifest | Indicates whether the process will fail if the old manifest is not found. | boolean | false | | -s, --sourceDir | The directory containing the source files. | string | "./src" | | -w, --watch | Watch the source files and recompile the posts when changes occur. | boolean | false | | -h, --help | Show help | boolean | |

Readme

Keywords

Package Sidebar

Install

npm i @jaybeeuu/compost

Weekly Downloads

0

Version

0.2.3

License

MIT

Unpacked Size

76.1 kB

Total Files

72

Last publish

Collaborators

  • jaybeeuu