{"id":15894440,"url":"https://github.com/capjamesg/vicdocs","last_synced_at":"2025-04-02T18:22:15.431Z","repository":{"id":189235859,"uuid":"680309542","full_name":"capjamesg/vicdocs","owner":"capjamesg","description":"Generate documentation for single-file VisionScript projects.","archived":false,"fork":false,"pushed_at":"2023-08-18T21:43:42.000Z","size":146,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T19:16:41.007Z","etag":null,"topics":["documentation","visionscript"],"latest_commit_sha":null,"homepage":"https://visionscript.dev/documenting/","language":"Python","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/capjamesg.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,"governance":null}},"created_at":"2023-08-18T21:41:16.000Z","updated_at":"2023-08-18T21:43:10.000Z","dependencies_parsed_at":"2023-08-18T22:56:48.972Z","dependency_job_id":"71718e3e-fd54-4c10-987e-b46e722a9160","html_url":"https://github.com/capjamesg/vicdocs","commit_stats":null,"previous_names":["capjamesg/vicdocs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capjamesg%2Fvicdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capjamesg%2Fvicdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capjamesg%2Fvicdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capjamesg%2Fvicdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/capjamesg","download_url":"https://codeload.github.com/capjamesg/vicdocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246866375,"owners_count":20846561,"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","visionscript"],"created_at":"2024-10-06T08:40:16.879Z","updated_at":"2025-04-02T18:22:15.410Z","avatar_url":"https://github.com/capjamesg.png","language":"Python","readme":"![A program documented with vicdocs](https://github.com/capjamesg/vicdocs/blob/main/vicdocs.png?raw=true)\n\n# vicdocs\n\n`vicdocs` is a documentation generator for [VisionScript](https://visionscript.dev).\n\n`vicdocs` reads a VisionScript file (`.vic`), parses the comments, and generates a HTML document with:\n\n1. The program code;\n2. The title, description, and author information specified (if any);\n3. A list of function definitions.\n\n`vicdocs` only works with single-file scripts.\n\n## Installation\n\n`vicdocs` is available on PyPI, so you can install it with `pip`:\n\n```bash\npip install vicdocs\n```\n\n## Usage\n\nTo generate a documentation file, run `vicdocs` with the path to the VisionScript file as the first argument:\n\n```bash\nvicdocs file.vic\n```\n\nThis will generate a HTML file in a `{file}-docs`, where `{file}` is the name of the VisionScript file for which you are generating documentation.\n\n## License\n\nThis project is licensed under an [MIT license](LICENSE).","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapjamesg%2Fvicdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcapjamesg%2Fvicdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapjamesg%2Fvicdocs/lists"}