Nanometers Per Millisecond

    @ansible/galaxy-doc-builder
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0-alpha4 • Public • Published

    Galaxy Doc Builder

    This package provides a series of react components that can be used render ansible plugin documentation. These components rely on the output from the galaxy importer

    Components

    RenderPluginDoc

    Renders the documentation strings from a plugin.

    Props

    • plugin: documentation blob for plugin being rendered. This is produced by the galaxy-importer.
    • renderModuleLink(moduleName): function that should return a link pointing to a module
    • renderDocLink(name, href): function that should return a link pointing to docs
    • renderTableOfContentsLink(title, section): function that returns a table of contents link for scrolling the page down to the various headers.
    • renderWarning(text): function that returns a warning banner when something breaks during rendering.

    Keywords

    none

    Install

    npm i @ansible/galaxy-doc-builder

    DownloadsWeekly Downloads

    145

    Version

    1.0.0-alpha4

    License

    Apache-2.0

    Unpacked Size

    122 kB

    Total Files

    15

    Last publish

    Collaborators

    • jlmitch5
    • zitanemeckova
    • newswangerd