{"id":19744998,"url":"https://github.com/webdoc-labs/webdoc","last_synced_at":"2025-04-08T03:18:22.242Z","repository":{"id":37245317,"uuid":"256891700","full_name":"webdoc-labs/webdoc","owner":"webdoc-labs","description":"Documentation generator for the web","archived":false,"fork":false,"pushed_at":"2024-09-27T12:59:36.000Z","size":6095,"stargazers_count":79,"open_issues_count":11,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-30T04:13:16.418Z","etag":null,"topics":["documentation-generator","jsdoc-comments","nodejs","webdoc"],"latest_commit_sha":null,"homepage":"https://www.webdoclabs.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webdoc-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-19T01:49:01.000Z","updated_at":"2024-06-14T09:27:03.000Z","dependencies_parsed_at":"2024-06-18T16:43:19.586Z","dependency_job_id":"b05ccdb9-4063-4051-9208-5eda1050582f","html_url":"https://github.com/webdoc-labs/webdoc","commit_stats":{"total_commits":70,"total_committers":4,"mean_commits":17.5,"dds":"0.24285714285714288","last_synced_commit":"7d3ad2801bec9f2de601e937361badda67306e52"},"previous_names":["sukantpal/webdoc"],"tags_count":123,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdoc-labs%2Fwebdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdoc-labs%2Fwebdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdoc-labs%2Fwebdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdoc-labs%2Fwebdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webdoc-labs","download_url":"https://codeload.github.com/webdoc-labs/webdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247426425,"owners_count":20937124,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation-generator","jsdoc-comments","nodejs","webdoc"],"created_at":"2024-11-12T02:01:50.944Z","updated_at":"2025-04-08T03:18:22.220Z","avatar_url":"https://github.com/webdoc-labs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"© 2020-2022 webdoc Labs\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://i.ibb.co/ZHP9PD8/Logo-Frame-5.png\" alt=\"Logo-Frame\" border=\"0\" width=\"256\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.codetriage.com/webdoc-labs/webdoc\"\u003e\u003cimg src=\"https://www.codetriage.com/webdoc-js/webdoc/badges/users.svg\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003ctable align=\"center\"\u003e\n  \u003ctr\u003e\n  \u003cth align=\"center\"\u003ewebdoc\u003c/th\u003e\n  \u003cth align=\"center\"\u003eExample documentation\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctbody align=\"center\"\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\n        \u003ca href=\"https://dev.azure.com/webdoc-labs/webdoc/_build/latest?definitionId=2\u0026branchName=master\"\u003e\n          \u003cimg src=\"https://dev.azure.com/webdoc-labs/webdoc/_apis/build/status/Build%2C%20unit-test%2C%20type-check?repoName=webdoc-labs%2Fwebdoc\u0026branchName=master\"\u003e\u003c/img\u003e\n        \u003c/a\u003e\n      \u003c/td\u003e\n      \u003ctd\u003e\n        \u003ca href=\"https://dev.azure.com/webdoc-labs/webdoc/_build/latest?definitionId=3\u0026branchName=master\"\u003e\n          \u003cimg src=\"https://dev.azure.com/webdoc-labs/webdoc/_apis/build/status/webdoc-example%20documentation%20generator?repoName=webdoc-labs%2Fwebdoc\u0026branchName=master\"\u003e\u003c/img\u003e\n        \u003c/a\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\nwebdoc is the next generation documentation generator for the family of web languages. It supports the JSDoc notation\nand infers type data from TypeScript definitions.\n\nYou can checkout the documentation for `example/` [here](https://webdoc-labs.github.io/example-documentation/index.html)!\n\n## Usage :newspaper_roll:\n\n```shell\nnpm install --save-dev @webdoc/cli\n```\n\nTo get started, create a `webdoc.conf.json` file in your project directory.\n\n```json\n{\n  \"source\": {\n    \"include\": \"src/\",\n    \"excludePattern\": \"(node_modules|lib|test)\"\n  },\n  \"plugins\": [\n    \"plugins/markdown\"\n  ],\n  \"opts\": {\n    \"destination\": \"docs\"\n  },\n  \"template\": {\n    \"repository\": \"\u003cyour_github_url\u003e\",\n    \"outputSourceFiles\": false\n  }\n}\n```\n\nThe only required field is `source.include` which tells webdoc where the source files are. [@webdoc/cli](packages/webdoc-cli)'s README details more configuration options\n\nYou can now run `webdoc` in your terminal and documentation will be generated. Be sure to serve the documentation from the folder it is generated in. If you need to serve from an ancestor directory, provide the documentation path relative to the root using the `--site-root` option, e.g. `webdoc --site-root docs`.\n\n## Features :tada:\n\n* Support for JavaScript, Flow, and TypeScript. The modular structure of @webdoc/parser allows you to integrate it with other languages as well.\n\n* High-performance document tree that enforces proper relationships between symbols.\n\n* Importing external APIs to integrate your documentation\n\nComing soon:\n\n* Documentation coverage analysis\n\n* Powerful default template that:\n  * integrates with JSFiddle \u0026 CodePen for live examples of your API\n  * provides a neat and clean navigation for users\n  * makes it easy to write tutorials\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdoc-labs%2Fwebdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebdoc-labs%2Fwebdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdoc-labs%2Fwebdoc/lists"}