Package Exports

index.md

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (index.md) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

index.md

Version

Flexible CLI that creates HTMLs from your Markdown files.

Screenshot

Screenshot 2

Installation

You can install it from npm.

> npm install -g index.md

Usage

The main command converts and with init it generates a config file.

Run

Convert all the .md files to .html files.

> index.md

Options

Here are all the options or configurations for index.md:

source Relative path to read your .md files (default is ".").
output Relative path to save your converted .html files (default is ".").
template Use an HTML template for standard web page (default is true).
nameAsTitle Use MD file name as HTML title (default is false).
firstLineAsTitle Use first line of MD file as HTML title (default is true).

Arguments

Here are all the args or parameters when running index.md command:

init Creates the config file with default values for each option.
help Prints out this README file.
version Prints out the current version.

Development

Here are the commands for development:

npm run build Compile the TS files to JS.
npm run start Run the app.js.
npm run lint Check code quality.