Skip to content
mdn man _

Getting Started

Installation

Section titled “Installation”

When using the Node API, you can install the package into your project’s dependencies.

Terminal window
npm install mdnman

When using the MDNMan CLI, it is recommended to install globally.

Terminal window
npm install --global mdnman

Usage

Section titled “Usage”

Node API

Section titled “Node API”
simple.ts
import {
    findMDNFile,
    getHeader,
    completeParse,
} from 'mdnman';


const file = await findMDNFile('foreach');
if (!file) return;
const header = getHeader(file);
if (!header) return;
const parsedFile = completeParse(file, header.slug, false);
console.log(parsedFile)

CLI

Section titled “CLI”

Invoke the MDNMan command line interface with the mdnman command.

Terminal window
mdnman
Usage: mdnman [options] [command]


MDN reference CLI


Options:
  -h, --help              display help for command


Commands:
  js [options] <query>       Search the MDN JavaScript reference library
  html [options] <query>     Search the MDN HTML reference library
  css [options] <query>      Search the MDN CSS reference library
  glossary [options] <query> Search the MDN Glossary
  interactive [options]      Use prompts to search the entire MDN reference library
  help [command]             Get help for specific command

A complete command with options would look like this.

Terminal window
mdnman interactive --output file --path ./my-mdn-doc.md