» Command: doc

The sentinel doc command is used to show the documentation for an import plugin.

» Usage

Usage: sentinel doc [options] [FILE]

This command shows the documentation for an import plugin in markdown format.

FILE should be a path to a directory or explicit Sentinel import doc file. If this isn't specified, it defaults to the current directory. For directories, Sentinel will look for a file named "doc.sentinel".

The output of this command is markdown. We recommend piping this output into a markdown viewer such as mdv.