webdoc - Home

Documentation
Generator

webdoc is a platform for documenting JavaScript and TypeScript code, guides & tutorials, monorepos, ecosystems, and much more.

Get Started
npm i --save-dev @webdoc/cli
// This site's webdoc.conf.json
{
    "source": {
        "includes": "guides/",
        "excludePattern": "json$"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "opts": {
        "destination": "docs/guides",
        "export": false
    },
    "template": {
        "applicationName": "{ <i>webdoc</i> }",
        "appBar": {
            "items": {
                "main-site": {
                    "name": "Main Site",
                    "uri": "https://www.webdoclabs.com"
                },
                "tutorials": {
                    "name": "Guides"
                }
            }
        },
        "repository": "https://source.shukantpal.com/webdoc-labs/www",
        "meta": {
            "og:title": "webdoc",
            "og:description": "webdoc is the next generation documentation engine for the web ecosystem!",
            "title": "webdoc"
        },
        "routes": {
            "tutorials": "/"
        },
        "integrations": {
            "analytics": {
                "provider": "plausible",
                "nakedDomain": "www.webdoclabs.com"
            }
        }
    }
}

One tool to rule it all


See who's using webdoc

pixijs logomelonjs logo