{"id":20384547,"url":"https://github.com/kitbashery/unity-markdown-generator","last_synced_at":"2025-04-12T09:23:57.116Z","repository":{"id":155448918,"uuid":"632639330","full_name":"Kitbashery/Unity-Markdown-Generator","owner":"Kitbashery","description":"Generate .md Markdown Documentation from Unity C# script assets.","archived":false,"fork":false,"pushed_at":"2024-08-28T19:30:22.000Z","size":55,"stargazers_count":18,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T04:21:53.393Z","etag":null,"topics":["csharp","documentation-generator","markdown","markdown-parser","monoscript","unity","unityasset","unityeditor"],"latest_commit_sha":null,"homepage":"https://kitbashery.com/","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/Kitbashery.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},"funding":{"github":"kitbashery","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-04-25T20:33:41.000Z","updated_at":"2024-12-05T19:07:35.000Z","dependencies_parsed_at":"2024-07-25T00:41:16.250Z","dependency_job_id":"975c3fca-3990-4849-a040-28c9a6cab702","html_url":"https://github.com/Kitbashery/Unity-Markdown-Generator","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/Kitbashery%2FUnity-Markdown-Generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitbashery%2FUnity-Markdown-Generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitbashery%2FUnity-Markdown-Generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitbashery%2FUnity-Markdown-Generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kitbashery","download_url":"https://codeload.github.com/Kitbashery/Unity-Markdown-Generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248544675,"owners_count":21121998,"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":["csharp","documentation-generator","markdown","markdown-parser","monoscript","unity","unityasset","unityeditor"],"created_at":"2024-11-15T02:28:24.923Z","updated_at":"2025-04-12T09:23:57.092Z","avatar_url":"https://github.com/Kitbashery.png","language":"C#","funding_links":["https://github.com/sponsors/kitbashery"],"categories":[],"sub_categories":[],"readme":"![](https://kitbashery.com/assets/images/kitbashery-github-banner.jpg)\n\n[![Unity Version](https://img.shields.io/badge/Unity-2021.3%2B-blue.svg)](https://unity3d.com/get-unity/download)\n[![GitHub](https://img.shields.io/github/license/kitbashery/modular-ai.svg)](https://github.com/Kitbashery/Unity-Markdown-Generator/blob/main/LICENSE)\n[![Contributing](https://img.shields.io/badge/Contribute-guidelines-lightgrey)](https://github.com/Kitbashery/.github/blob/main/.github/CONTRIBUTING.md)\n\n# Unity-Markdown-Generator\nGenerate .md Markdown Documentation from Unity C# script assets.\n\n## Usage:\n\nRight-click a script asset then click \"Generate Markdown Documentation\".\n\n## Limitations:\n\n- Only documents the class that shares the script file name.\n- Namespace names and assembly names must match.\n- Only documents public properties, methods and fields.\n- XML Summary comment support is WIP.\n\n## Comment Support:\n\n- Tooltip attributes for properties.\n- Parameter XML comments for methods.\n\n## Example:\n\n#### The script should turn code structured like this:\n```\nNamespace myNamespace.space\n{\n\n/// \u003csummary\u003e\n/// Test class summary.\n/// \u003c/summary\u003e\npublic class TestClass\n{\n\n [Tooltip(\"My tooltip text.\")]\n    public int property = 0;\n\n    /// \u003csummary\u003e\n    /// Property2 summary.\n    /// \u003c/summary\u003e\n    public int property2 = 1;\n\n    /// \u003csummary\u003e\n    /// Test method summary.\n    /// \u003c/summary\u003e\n    /// \u003cparam name=\"param1\"\u003eparam1 summary\u003c/param\u003e\n    /// \u003cparam name=\"param2\"\u003eparam2 summary\u003c/param\u003e\n    /// \u003cparam name=\"param3\"\u003eparam3 summary\u003c/param\u003e\n    public void Test(int param1, string param2, int param3 = 1)\n    {\n\n    }\n}\n```\n\n#### To this output:\n\n```\n# TestClass:\nTest class summary.\n\n### Namespace:\nmyNamespace.space\n\n## Properties:\n\n| Type        | Name | Description         | Default Value |\n|:------------|:-----|:--------------------|:--------------|\n|  `int` | property | My tooltip text. | 0 |\n|  `int` | property2 |  Property2 summary. | 1 |\n\n## Methods:\n\n| Name | Summary      | Parameters | Returns |\n|:-----|:-------------|:-----------|:--------|\n| Test |  Test method summary. | `int` param1 \"param1 summary\" , `string` param2 \"param2 summary\", `int` param3 \"param3 summary\" = 1  | `Void` |\n```\n\n#### Rendered:\n\n# TestClass:\nTest class summary.\n\n### Namespace:\nmyNamespace.space\n\n## Properties:\n\n| Type        | Name | Description         | Default Value |\n|:------------|:-----|:--------------------|:--------------|\n|  `int` | property | My tooltip text. | 0 |\n|  `int` | property2 |  Property2 summary. | 1 |\n\n## Methods:\n\n| Name | Summary      | Parameters | Returns |\n|:-----|:-------------|:-----------|:--------|\n| Test |  Test method summary. | `int` param1 \"param1 summary\" , `string` param2 \"param2 summary\", `int` param3 \"param3 summary\" = 1  | `Void` |\n\n\n---\nThe name Kitbashery \u0026 all associated images Copyright \u0026copy; 2023 Kitbashery. All Rights Reserved.\n\n\u003ci\u003e\"Unity\", Unity logos, and other Unity trademarks aretrademarks or registered trademarks of Unity Technologies. \nNotice: This script is an internal tool of Kitbashery and not part of Kitbashery's product library and is provided AS IS. The name Unity is only used to elaborate on what technology stack this parser is for.\u003c/i\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitbashery%2Funity-markdown-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitbashery%2Funity-markdown-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitbashery%2Funity-markdown-generator/lists"}