presidium-jsdoc

    0.0.4 • Public • Published

    Presidium Jsdoc

    A template-based tool for importing Jsdoc into you Presidium documentation.

    This tool uses the Jsdoc node module to parse and generate your documentation with a customized template based off of Jsdoc's default template. It produces html files, structures them appropriately and inserts them into your Presidium project.

    Install

    In your project root:

    $ npm install --save presidium-jsdoc

    Usage:

    Standalone

    usage: presidium-jsdoc
    
    Option Description
    -d,--directory path The path to the output directory in ./content e.g. ./content/_reference/mydocs. \n
    -h,--help Shows this help.
    -p,--path path The path from which static files are served e.g. ./media/import/mydocs. Defaults to ./media/jsdoc/<title>.
    -s,--sourcepath path The path to the project's source.
    -t,--title string The title of the output folder. Defaults to the directory name supplied with -d if no package information can be found.

    In Presidum

    $ npm run presidium-jsdoc -s <path> -d <path> -t <string> -p <path>

    Known Issues:

    1. Does not yet support user supplied Jsdoc config.
    2. Links to pages are not yet resolved by this tool.
    3. Does not yet allow author tags to be added to the ingested documentation.

    Keywords

    none

    Install

    npm i presidium-jsdoc

    DownloadsWeekly Downloads

    2

    Version

    0.0.4

    License

    Apache-2.0

    Last publish

    Collaborators

    • span.presidium