hiulit/GDScriptify

A magical documentation tool for GDScript.

GDScriptify

A magical documentation tool for GDScript.

Introduction

GDScriptify is an API documentation generator tool for GDScript that converts comments you write alongside the code into Markdown documentation files.

It's great for documenting Godot plugins or frameworks. Even for just small one-script projects.

Table of contents

• Prerequisites
• Installation
• Usage
• Options
• Documentation
• Getting started
• Examples

Prerequisites

• Node.js installed on your computer.

Installation

npm install gdscriptify -g

Usage

gdscriptify [options]

Options

• -h, --help: Show help menu.
• -d, --directory path: Path from which to generate the documentation.
  • It can be an absolute path.
  • It can be a relative path (has to start with ./).
  • It must contain a project.godot file.
  • Default: ./.
• -o, --ouput path: Path to store the documentation.
  • It must be a relative path to --directory.
  • Default: docs.
• -c, --code {true|false}: Generate a "Code Reference" JSON file to --output.
  • Default: false.
• -m, --markdown {true|false}: Generate Markdown files to --output.
  • Default: true.
• -r, --readme false: Prevent generating a README file.
  • Only has effect when there's 1 GDScript file.
  • Default: true.
• -v, --version: Show package version.

Documentation

• How to document GDScript files.
• Generate a README file.

Getting started

First of all, you have to document the GDScript files.

Once that's done:

• Open a Terminal.
• Go to your Godot's project folder.
• Run gdscriptify.

cd /path/to/your/godot/project
gdscriptify

Or, if you don't want to have to go the folder, you can run gdscriptify with -d [path] from anywhere.

gdscriptify -d /path/to/your/godot/project

Assuming 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.

project
├── another_awesome_script.gd
├── awesome_script.gd
├── docs
│   ├── another_awesome_script.md
│   └── awesome_script.md
├── icon.png
└── project.godot

If there's only 1 GDScript file in the project, GDScriptify will create a README.md file in the root of your Godot's project.

project
├── awesome_script.gd
├── icon.png
├── project.godot
└── README.md

Check out the documentation on generating a README file to learn how to make it look better.

If you don't want that one file to be converted into a README file, run:

gdscriptify -r false

Examples

• Godot 3 2D Day/Night Cycle - Documentation.
• Godot 3 2D Draw Sprite - README.
• Godot 3 2D Fake Confetti Particles - README.
• Godot 3 2D Fake Snow Particles - README.

🗒️ Changelog

See CHANGELOG.

👤 Author

• hiulit

🤝 Contributing

Feel free to:

• Open an issue if you find a bug.
• Create a pull request if you have a new cool feature to add to the project.

🙌 Supporting this project

If you find this project helpful, please consider supporting it through any size donations to help make it better.

If you can't, consider sharing it with the world...

... or giving it a star.

👏 Credits

Thanks to:

• Andrea Calabró - For creating the Godot logo.
• Twemoji - For the emojis.

📝 Licenses

• Source code: MIT License.
• Godot logo: CC BY 3.0.
• Emojis: CC BY 4.0.