{"id":23694562,"url":"https://github.com/mcneel/docify","last_synced_at":"2025-09-17T15:44:11.639Z","repository":{"id":38125270,"uuid":"246201819","full_name":"mcneel/docify","owner":"mcneel","description":"Generate API documentation for Rhino and Grasshopper related APIs","archived":false,"fork":false,"pushed_at":"2024-12-12T00:28:54.000Z","size":18397,"stargazers_count":5,"open_issues_count":14,"forks_count":1,"subscribers_count":25,"default_branch":"master","last_synced_at":"2024-12-12T01:26:09.528Z","etag":null,"topics":["grasshopper","rhino3d","rhinocommon"],"latest_commit_sha":null,"homepage":"https://mcneel-apidocs.herokuapp.com/rhinocommon/rhino.angleunitsystem","language":"C#","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/mcneel.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-10T03:43:29.000Z","updated_at":"2024-12-12T00:28:58.000Z","dependencies_parsed_at":"2023-01-25T13:00:38.562Z","dependency_job_id":"ae005f15-f120-4a08-b318-c035b7f0c3ca","html_url":"https://github.com/mcneel/docify","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcneel%2Fdocify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcneel%2Fdocify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcneel%2Fdocify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcneel%2Fdocify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mcneel","download_url":"https://codeload.github.com/mcneel/docify/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231813558,"owners_count":18430480,"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":["grasshopper","rhino3d","rhinocommon"],"created_at":"2024-12-30T04:27:16.753Z","updated_at":"2025-09-17T15:44:11.495Z","avatar_url":"https://github.com/mcneel.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docify\nProject for generating Rhino/Grasshopper API documentation. This repo is split into the following parts:\n\n# src \nsrc contains a Visual Studio project (api_docify) that parses source code and generates markdown and json files that represent the public facing API for a project\n# quasar_site\na quasar project that creates a web site based on the json files created. This site currently gets published to heroku and can be viewed at\n\nhttps://mcneel-apidocs.herokuapp.com/api/rhinocommon/\n\nInstructions for building and testing the quasar site can be found at\n[quasar site readme](quasar_site/readme.md)\n\n\n## Usage\n\n```shell\n$ api_docify --name=\u003cproj_name\u003e \u003cproj_path\u003e \u003cproj_output_js\u003e\n$ api_docify --name=\u003cproj_name\u003e \u003cproj_path\u003e \u003cproj_output_js\u003e \u003cexamples_path\u003e \u003cexamples_output_js\u003e\n```\n\n**Example**\n\n```shell\n$ api_docify.exe --name=\"RhinoCommon\" \"%RHINO4SRC%/rhinocommon/dotnet\" \"src/modules/docify/quasar_site/src/RhinoCommonApi.js\"\n```\n\n# VS Code (Mac) setup instructions\n\n1. Ensure node, npm, and quasar are installed\n2. Open this folder in VS Code\n3. Run `CMD+Shift+P \u003e Run Task \u003e initial setup (npm)` \n4. Run `CMD+Shift+P \u003e Run Task \u003e docify init`, then enter the path where the Rhino source code is located and press enter.\n5. Run `CMD+Shift+P \u003e Run Task \u003e docify build`\n5. Run `CMD+Shift+P \u003e Run Task \u003e run quasar`\n\n## Troubleshooting\n\nSome namespaces may need `methodgen` to be run on the source first before documentation can be extracted. You can do this by building Rhino from source.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcneel%2Fdocify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmcneel%2Fdocify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcneel%2Fdocify/lists"}