{"id":15085963,"url":"https://github.com/twlite/node-deno_doc","last_synced_at":"2025-10-05T15:31:37.044Z","repository":{"id":57685860,"uuid":"486996869","full_name":"twlite/node-deno_doc","owner":"twlite","description":"WASM bindings to deno_doc for Node.js","archived":true,"fork":false,"pushed_at":"2022-04-29T14:56:52.000Z","size":1041,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-26T07:02:13.149Z","etag":null,"topics":["deno","docgen","documentation","generator","javascript","jsdoc","node","typedoc","typescript","url"],"latest_commit_sha":null,"homepage":"https://npm.im/deno_doc","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/twlite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-29T14:12:14.000Z","updated_at":"2023-01-27T19:30:41.000Z","dependencies_parsed_at":"2022-09-18T23:12:24.096Z","dependency_job_id":null,"html_url":"https://github.com/twlite/node-deno_doc","commit_stats":null,"previous_names":["devandromeda/node-deno_doc","twlite/node-deno_doc"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twlite%2Fnode-deno_doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twlite%2Fnode-deno_doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twlite%2Fnode-deno_doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/twlite%2Fnode-deno_doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/twlite","download_url":"https://codeload.github.com/twlite/node-deno_doc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219877025,"owners_count":16554818,"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":["deno","docgen","documentation","generator","javascript","jsdoc","node","typedoc","typescript","url"],"created_at":"2024-09-25T07:02:18.507Z","updated_at":"2025-10-05T15:31:36.440Z","avatar_url":"https://github.com/twlite.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `deno_doc`\n\nA **[Deno Doc](https://github.com/denoland/deno_doc)** port for Node.js\n\n# Features\n* Asynchronous\n* Supports both JavaScript and TypeScript\n* Generates documentation from remote url or file path\n* ESM \u0026 CJS supported\n\n# Installation\n\n```sh\n# npm\n$ npm install --save deno_doc\n# Yarn\n$ yarn add deno_doc\n```\n\n# Example Usage\n\n```js\n// ES Modules\nimport { doc } from \"deno_doc\";\n\nconst colorsDoc = await doc(\"https://deno.land/std/fmt/colors.ts\");\n\nfor (const node of colorsDoc) {\n  console.log(`name: ${node.name} kind: ${node.kind}`);\n}\n\n// CommonJS\nconst { doc } = require(\"deno_doc\");\n\nconst colorsDoc = await doc(\"https://deno.land/std/fmt/colors.ts\");\n\nfor (const node of colorsDoc) {\n  console.log(`name: ${node.name} kind: ${node.kind}`);\n}\n```\n\n# API\n\n## `doc()`\n\nThe `doc()` function takes a string URL module specifier and potentially some options, and asynchronously resolves with an array of documentation nodes, which represent the surface API of the module.\n\nA minimal example of using `doc()` and printing out some information about a function:\n\n```js\nimport { doc } from \"deno_doc\";\n\nconst colorsDoc = await doc(\"https://deno.land/std/fmt/colors.ts\");\n\nfor (const node of colorsDoc) {\n  console.log(`name: ${node.name} kind: ${node.kind}`);\n}\n```\n\nThe `doc()` function needs a way to retrieve modules, and by default uses a `load()` function provided by a partial implementation of `deno_graph` which uses `fetch()` for remote modules and `fs.readFile()` for local modules.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwlite%2Fnode-deno_doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftwlite%2Fnode-deno_doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwlite%2Fnode-deno_doc/lists"}