@hz-9/docs-build

A toos for generate vuepress-theme-hopo from typescript project.

Introduction

@hz-9/docs-build will scan the markdown files of a project based on certain rules and compile them into a vuepress-theme-hopo website. For logic, please refer to the Scan Rule.

Installation

npm install --global @hz-9/docs-build

Usage

Get help:

docs-build --help

Minimal execution:

docs-build

Developer mode:

docs-build --action serve

serve only listens for changes in file content. If a file that matches the rules is added, the current command needs to be restarted.

Production Env:

docs-build --action build

Parameters

-r, --root

The execution path, default is process.cwd(). This parameter will affects the reading of the package.json file and the resolution of other relative paths.

-c, --config

The path to api-extractor.json. Support absolute path or relative path.

--docs-space

The space to docs website. If omitted, it is ./docs/.vuepress.

--markdown-path

The markdown folder generated using @microsoft/api-documenter. If omitted, it is ./docs/.markdowns.

-a, --action

Vuepress Action. Support serve or build.

--base-url

Vuepress base url. If omitted, it is /.