@imolko/show-dossiers

Generate markdown dossiers visualitation

Installation

You can install this package globally using npm:

npm install @imolko/show-dossiers

Or you can run it directly without installation using npx:

npx @imolko/show-dossiers generate ...

Usage

This CLI tool provides the generate command to create documentation from dossier JSON files.

generate

This command reads dossier files from a specified directory, processes them, and generates corresponding markdown files in a documentation-ready structure.

Example:

npx @imolko/show-dossiers generate -p dossiers -g docs -b ../../static/img

Options

The generate command accepts the following options:

• -p, --path <path>

  • Description: Specifies the directory where the source dossier .json files are located.
  • Default: ./dossiers

• -g, --generated-docs-path <path>

  • Description: Specifies the output directory where the generated markdown documentation files will be saved.
  • Default: ./docs

• -b, --base-path <path>

  • Description: Sets the base path for media resources (like images) that are referenced within the generated markdown files. This is useful for ensuring that links to assets are correct in the final documentation site (e.g., Docusaurus).
  • Default: ../../static/img