{"id":22619560,"url":"https://github.com/mattmcfarland/docsense","last_synced_at":"2026-04-27T23:36:15.775Z","repository":{"id":57214203,"uuid":"111319544","full_name":"MattMcFarland/docsense","owner":"MattMcFarland","description":"An intelligent documentation generator for Ecmascript, Typescript, and Flowtype","archived":false,"fork":false,"pushed_at":"2018-05-22T17:34:54.000Z","size":1673,"stargazers_count":3,"open_issues_count":11,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-19T08:37:08.277Z","etag":null,"topics":["ast","documentation-generator","ecmascript","javascript","parsing","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MattMcFarland.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":"2017-11-19T18:07:34.000Z","updated_at":"2023-03-05T05:26:16.000Z","dependencies_parsed_at":"2022-08-26T13:41:26.204Z","dependency_job_id":null,"html_url":"https://github.com/MattMcFarland/docsense","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MattMcFarland%2Fdocsense","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MattMcFarland%2Fdocsense/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MattMcFarland%2Fdocsense/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MattMcFarland%2Fdocsense/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MattMcFarland","download_url":"https://codeload.github.com/MattMcFarland/docsense/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246126671,"owners_count":20727594,"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":["ast","documentation-generator","ecmascript","javascript","parsing","typescript"],"created_at":"2024-12-08T22:06:07.626Z","updated_at":"2026-04-27T23:36:15.671Z","avatar_url":"https://github.com/MattMcFarland.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Docsense\n\nDocsense is a pluggable and customizable AST to documentation generator which\nparses ECMASCIPT 2015+ using\n[Babylon](https://github.com/babel/babel/tree/master/packages/babylon),\n\n\u003e 🤖 **It is still in early development, but operational! ** 🤖\n\n### Quick start\n```\n# Add with yarn\nyarn add docsense\n# Run init to create the default config file\nyarn docsense init\n# Run build to see your docs!\nyarn docsense build\n```\n[More info about CLI](src/cli)\n### Development\n\n:muscle: Clone the project, then run `yarn` to install all dependencies.\n\n```\ngit clone https://github.com/MattMcFarland/docsense\n```\n\n```\nyarn\n```\n\n### Scripts\n\nThere are a number of scripts that may be run using `yarn` - the ones that\nshould work independent of developer environments are as follows:\n\n--------------------------------------\n| Command      | Description         |\n| ------------ | ------------------- |\n| `yarn test`  | Runs all unit tests |\n| `yarn build` | Compiles source     |\n| `yarn docs`  | Runs the compiled code against this project |\n| `yarn dev-docs` | Watches `src/generator` for changes, building the new documentation on changes. This will not work unless docs have already been built first. |\n--------------------------\n\n### Debugging\n\nThis project may be debugged with [VSCode](https://code.visualstudio.com/), and has not been tested with other\nIDEs.  You can set breakpoints within the source code, press `F5` and run.  The debug mode will basically run `docs` against this project, generating the `db.json` (and eventually the docs) as if you were to run `docsense` against this project in production.\n\n### Architecture\nDocsense will eventualy run in the command line against the `process.cwd()` of the project a user has it installed in as a module.  As of now, it only runs against this project, parsing all of the code, then creating a database which may be queried by the document generator.  The document generator is currently unfinished, so after running `yarn docs` - you may run `yarn dev-docs` which will runs a local server that hosts the generated documentation, updating automatically as you make changes to the generator scripts found in `src/generator`\n\n```\nExecution -\u003e\n  Read .docsenserc Config -\u003e\n    Generate AST -\u003e\n      Execute all plugins -\u003e\n        Plugin visitors create a database -\u003e\n          Static Docs are generated\n```\n\n### LICENSE\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattmcfarland%2Fdocsense","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattmcfarland%2Fdocsense","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattmcfarland%2Fdocsense/lists"}