pencil-js/pencil.js

View on GitHub
.jsdocrc

Summary

Maintainability
Test Coverage
{
    "source": {
        "include": ["src", "documentation.md"],
        "includePattern": "\\.js$",
        "excludePattern": "test\\.js$"
    },
    "plugins": ["plugins/markdown", "node_modules/jsdoc-babel"],
    "opts": {
        "recurse": true,
        "destination": "./docs",
        "template": "./node_modules/clean-jsdoc-theme",
        "theme_opts": {
            "meta": [
                {
                    "name": "title",
                    "property": "og:title",
                    "content": "Pencil.js documentation"
                },
                {
                    "name": "description",
                    "property": "og:description",
                    "content": "Full documentation for the Pencil.js library."
                },
                {
                    "name": "image",
                    "property": "og:image",
                    "content": "./media/logo-media.png"
                },
                {
                    "property": "og:image:alt",
                    "content": "Pencil.js written with shapes behind."
                },
                {
                    "name": "author",
                    "content": "GMartigny"
                },
                {
                    "name": "twitter:creator",
                    "content": "@gmartigny"
                },
                {
                    "property": "og:type",
                    "content": "website"
                },
                {
                    "name": "twitter:card",
                    "content": "summary_large_image"
                }
            ],
            "add_style_path": [
                {
                    "type": "image/png",
                    "rel": "shortcut icon",
                    "href": "./media/mini-logo.png"
                }
            ],
            "theme": "dark",
            "exclude_inherited": true,
            "title": "Pencil.js",
            "menu": [
                {
                    "title": "\uD83C\uDF10 Website",
                    "link": "https://pencil.js.org/"
                },
                {
                    "title": "\uD83D\uDCC4 Repository",
                    "link": "https://github.com/pencil-js/pencil.js"
                }
            ],
            "static_dir": ["./media"],
            "create_style": "#main h1::after { background-color: #642b73; } #main h2::after { background-color: #C6426E; } img { vertical-align: middle; }",
            "footer": "Made with ❤️, <a href='https://vercel.com?utm_source=pencil-js&utm_campaign=oss'><img src='./media/vercel.svg'></a>"
        }
    },
    "tags": {
        "allowUnknownTags": false,
        "dictionaries": ["jsdoc"]
    }
}