{"id":23413568,"url":"https://github.com/zumerlab/zumerbox-doc-extractor","last_synced_at":"2025-04-09T04:47:30.788Z","repository":{"id":231755173,"uuid":"782633581","full_name":"zumerlab/zumerbox-doc-extractor","owner":"zumerlab","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-10T08:14:06.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T22:37:03.624Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zumerlab.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2024-04-05T17:38:42.000Z","updated_at":"2024-04-05T17:45:03.000Z","dependencies_parsed_at":"2024-04-10T09:30:32.951Z","dependency_job_id":null,"html_url":"https://github.com/zumerlab/zumerbox-doc-extractor","commit_stats":null,"previous_names":["zumerlab/zumerbox-doc-extractor"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zumerlab%2Fzumerbox-doc-extractor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zumerlab%2Fzumerbox-doc-extractor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zumerlab%2Fzumerbox-doc-extractor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zumerlab%2Fzumerbox-doc-extractor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zumerlab","download_url":"https://codeload.github.com/zumerlab/zumerbox-doc-extractor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980821,"owners_count":21027803,"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":[],"created_at":"2024-12-22T19:38:10.980Z","updated_at":"2025-04-09T04:47:30.755Z","avatar_url":"https://github.com/zumerlab.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @zumerbox/doc-extractor\n\nDocExtractor is a Node.js script designed to extract comments from CSS, SCSS, and JavaScript files and generate Markdown documentation files. It provides a command-line interface (CLI) for easy usage.\n\nRefer to the [ZumerBox bundle](https://github.com/zumerlab/zumerbox) for more information and tools.\n\n## Installation\n\n```bash\nnpm install @zumerbox/doc-extractor --save-dev\n```\n\n## Usage\n\nTo use DocExtractor, run it from the command line with the following syntax:\n\n```bash\nnpx doc-extractor [entryPath] [options]\n```\n\n### Options:\n\n- `[entryPath]`: Path to the entry file, multiple files, or a folder containing the files to extract comments from.\n\n- `-folder [outputFolder]`: Specify the output folder for the generated Markdown files. (Default: 'output')\n\n- `-multiple`: Generate one Markdown file per input file. By default, a consolidated Markdown file named 'docs.md' will be created.\n\n- `-scss-imports`: Include this flag to process SCSS files with `@import` statements. It will extract comments from imported files as well.\n\n### Example:\n\nExtract comments from a single file:\n\n```bash\nnpx doc-extractor index.js\n```\n\nExtract comments from multiple files:\n\n```bash\nnpx doc-extractor src -multiple\n```\n\nGenerate documentation for SCSS files with imports:\n\n```bash\nnpx doc-extractor styles/main.scss -scss-imports\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzumerlab%2Fzumerbox-doc-extractor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzumerlab%2Fzumerbox-doc-extractor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzumerlab%2Fzumerbox-doc-extractor/lists"}