{"id":14961791,"url":"https://github.com/hiulit/gdscriptify","last_synced_at":"2025-10-24T22:30:43.696Z","repository":{"id":50630802,"uuid":"405911009","full_name":"hiulit/GDScriptify","owner":"hiulit","description":"A magical documentation tool for GDScript.","archived":false,"fork":false,"pushed_at":"2022-09-05T20:40:55.000Z","size":578,"stargazers_count":52,"open_issues_count":6,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-17T16:39:16.298Z","etag":null,"topics":["documentation","gdscript","godot-engine","magical","tool"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/hiulit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"patreon":"hiulit","ko_fi":"hiulit","custom":"https://www.paypal.me/hiulit"}},"created_at":"2021-09-13T09:30:19.000Z","updated_at":"2025-08-01T13:43:25.000Z","dependencies_parsed_at":"2022-08-24T16:10:40.791Z","dependency_job_id":null,"html_url":"https://github.com/hiulit/GDScriptify","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/hiulit/GDScriptify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiulit%2FGDScriptify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiulit%2FGDScriptify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiulit%2FGDScriptify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiulit%2FGDScriptify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hiulit","download_url":"https://codeload.github.com/hiulit/GDScriptify/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hiulit%2FGDScriptify/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280878370,"owners_count":26406641,"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","status":"online","status_checked_at":"2025-10-24T02:00:06.418Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","gdscript","godot-engine","magical","tool"],"created_at":"2024-09-24T13:27:40.085Z","updated_at":"2025-10-24T22:30:43.382Z","avatar_url":"https://github.com/hiulit.png","language":"JavaScript","readme":"# GDScriptify\n\n![release v1.0.0](https://img.shields.io/badge/release-v1.0.0-478cbf?style=flat-square) ![MIT license](https://img.shields.io/badge/license-MIT-478cbf?style=flat-square)\n\nA magical documentation tool for GDScript.\n\n![GDScriptify banner](/gdscriptify-banner.jpg)\n\n## Introduction\n\nGDScriptify is an API documentation generator tool for GDScript that converts comments you write alongside the code into Markdown documentation files.\n\nIt's great for documenting Godot plugins or frameworks. Even for just small one-script projects.\n\n## Table of contents\n\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Options](#options)\n- [Documentation](#documentation)\n- [Getting started](#getting-started)\n- [Examples](#examples)\n\n## Prerequisites\n\n- [Node.js](https://nodejs.org) installed on your computer.\n\n## Installation\n\n```bash\nnpm install gdscriptify -g\n```\n\n## Usage\n\n```bash\ngdscriptify [options]\n```\n\n## Options\n\n- `-h, --help`: Show help menu.\n- `-d, --directory path`: Path from which to generate the documentation.\n  - It can be an absolute path.\n  - It can be a relative path (has to start with `./`).\n  - It must contain a `project.godot` file.\n  - Default: `./`.\n- `-o, --ouput path`: Path to store the documentation.\n  - It must be a relative path to `--directory`.\n  - Default: `docs`.\n- `-c, --code {true|false}`: Generate a \"Code Reference\" JSON file to `--output`.\n  - Default: `false`.\n- `-m, --markdown {true|false}`: Generate Markdown files to `--output`.\n  - Default: `true`.\n- `-r, --readme false`: Prevent generating a `README` file.\n  - Only has effect when there's 1 GDScript file.\n  - Default: `true`.\n- `-v, --version`: Show package version.\n\n## Documentation\n\n- [How to document GDScript files](/docs/how-to-document-gdscript-files.md).\n- [Generate a README file](/docs/generate-a-readme-file.md).\n\n## Getting started\n\nFirst of all, you have to [document the GDScript files](/docs/how-to-document-gdscript-files.md).\n\nOnce that's done:\n\n- Open a Terminal.\n- Go to your Godot's project folder.\n- Run `gdscriptify`.\n\n```bash\ncd /path/to/your/godot/project\ngdscriptify\n```\n\nOr, if you don't want to have to go the folder, you can run `gdscriptify` with `-d [path]` from anywhere.\n\n```bash\ngdscriptify -d /path/to/your/godot/project\n```\n\nAssuming GDScriptify's default values are being used, a `docs` folder will be created in the root of your Godot's project (where `project.godot` or `plugin.cfg` is located) with the documentation files.\n\n```\nproject\n├── another_awesome_script.gd\n├── awesome_script.gd\n├── docs\n│   ├── another_awesome_script.md\n│   └── awesome_script.md\n├── icon.png\n└── project.godot\n```\n\nIf there's **only 1 GDScript file** in the project, GDScriptify will create a `README.md` file in the root of your Godot's project.\n\n```\nproject\n├── awesome_script.gd\n├── icon.png\n├── project.godot\n└── README.md\n```\n\nCheck out the documentation on [generating a README file](/docs/generate-a-readme-file.md) to learn how to make it look better.\n\nIf you don't want that one file to be converted into a README file, run:\n\n```\ngdscriptify -r false\n```\n\n## Examples\n\n- [Godot 3 2D Day/Night Cycle](https://github.com/hiulit/Godot-3-2D-Day-Night-Cycle/tree/master/docs) - Documentation.\n- [Godot 3 2D Draw Sprite](https://github.com/hiulit/Godot-3-2D-Draw-Sprite) - README.\n- [Godot 3 2D Fake Confetti Particles](https://github.com/hiulit/Godot-3-2D-Fake-Confetti-Particles) - README.\n- [Godot 3 2D Fake Snow Particles](https://github.com/hiulit/Godot-3-2D-Fake-Snow-Particles) - README.\n\n## 🗒️ Changelog\n\nSee [CHANGELOG](/CHANGELOG.md).\n\n## 👤 Author\n\n- hiulit\n\n## 🤝 Contributing\n\nFeel free to:\n\n- [Open an issue](https://github.com/hiulit/GDScriptify/issues) if you find a bug.\n- [Create a pull request](https://github.com/hiulit/GDScriptify/pulls) if you have a new cool feature to add to the project.\n\n## 🙌 Supporting this project\n\nIf you find this project helpful, please consider supporting it through any size donations to help make it better.\n\n[![Become a patron](https://img.shields.io/badge/Become_a_patron-ff424d?logo=Patreon\u0026style=for-the-badge\u0026logoColor=white)](https://www.patreon.com/hiulit)\n\n[![Suppor me on Ko-Fi](https://img.shields.io/badge/Support_me_on_Ko--fi-F16061?logo=Ko-fi\u0026style=for-the-badge\u0026logoColor=white)](https://ko-fi.com/F2F7136ND)\n\n[![Buy me a coffee](https://img.shields.io/badge/Buy_me_a_coffee-FFDD00?logo=buy-me-a-coffee\u0026style=for-the-badge\u0026logoColor=black)](https://www.buymeacoffee.com/hiulit)\n\n[![Donate Paypal](https://img.shields.io/badge/PayPal-00457C?logo=PayPal\u0026style=for-the-badge\u0026label=Donate)](https://www.paypal.com/paypalme/hiulit)\n\nIf you can't, consider sharing it with the world...\n\n[![](https://img.shields.io/badge/Share_on_Twitter-1DA1F2?style=for-the-badge\u0026logo=twitter\u0026logoColor=white)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fhiulit%2FGDScriptify\u0026text=%22Godot+3+2D+Day%2FNight+Cycle%22%0D%0AA+2D+%E2%98%80%EF%B8%8F+Day+%2F+%F0%9F%8C%94+Night+cycle+using+CanvasModulate+and+a+moon+light+effect+using+Light2D+by+%40hiulit)\n\n... or giving it a [star](https://github.com/hiulit/GDScriptify/stargazers).\n\n## 👏 Credits\n\nThanks to:\n\n- **Andrea Calabró** - For creating the Godot logo.\n- [Twemoji](https://twemoji.twitter.com/) - For the emojis.\n\n## 📝 Licenses\n\n- Source code: [MIT License](/LICENSE).\n- Godot logo: [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/).\n- Emojis: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).\n","funding_links":["https://patreon.com/hiulit","https://ko-fi.com/hiulit","https://www.paypal.me/hiulit","https://www.patreon.com/hiulit","https://ko-fi.com/F2F7136ND","https://www.buymeacoffee.com/hiulit","https://www.paypal.com/paypalme/hiulit"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiulit%2Fgdscriptify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhiulit%2Fgdscriptify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiulit%2Fgdscriptify/lists"}