Neil Patrick's Mansion

    makestatic-verify-anchor

    1.0.10 • Public • Published

    Verify Anchor

    Verify anchor links exist

    For each HTML file check that a elements with a hash part in the href reference a valid id attribute.



    Install

    yarn add makestatic-verify-anchor
    

    API

    VerifyAnchor

    Verify links to named anchors exist on the page.

    Checks links that have href attributes pointing to id attributes on the same page (href="#id") or on another page (href="about.html#id").

    If the path looks like a directory then the target page is deemed to be an index.html file, use the index option if you are using a different index file.

    Note that this implementation verifies that a corresponding element with an id attribute exists on the page, it does not check for elements with a name attribute as HTML5 no longer supports this style of named anchors.

    Link href attributes that have a protocol are deemed to be absolute and outside of the resource graph structure - they are not followed.

    See Also

    .after

    VerifyAnchor.prototype.after(context, options)

    Verifies that named anchors in each HTML document exist.

    When strict is disabled an error is not thrown but a warning message is logged.

    • context Object the processing context.
    • options Object the plugin options.
    Options
    • strict Boolean=true warn rather than error when false.
    • index String=index.html index file for directory paths.
    Throws
    • Error if no resource graph is available.
    • Error when a named anchor is missing in strict mode.

    License

    MIT


    Created by mkdoc on March 12, 2017

    Install

    npm i makestatic-verify-anchor

    DownloadsWeekly Downloads

    37

    Version

    1.0.10

    License

    MIT

    Last publish

    Collaborators

    • tmpfs