godotjs / godotjs/javascript

API Documentation

未关闭
#65 3 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
enhancement
主要语言
C++
星标
1.1k
派生
80
PR 合并指标
30 天内没有已合并 PR

描述

As far as I can tell there is no easily accessible API documentation outside of the source code.

However, the typescript declaration file has most functions documented in addition to its types.

I suggest using `typedoc` to generate documentation. Users can do this themselves or this can be hosted online for free. An example: https://funkia.github.io/hareactive/

This command worked for me:

```
typedoc —out godot-ts-doc ./godot.d.ts —ignoreCompilerErrors —module commonjs —target es6 —includeDeclarations ./godot.d.ts
```

Additionally, I am available to help with documentation beyond this. This is a high-quality project and I would like to help it be as visible and accessible as possible.

贡献指南

打开贡献指南

调研方向

首先查看 TypeScript 声明文件 godot.d.ts 和提供的 typedoc 命令。完成的标准是根据这些声明生成 API 文档,并通过有文档说明的本地生成方式或在线主机,让用户能够访问生成的文档。

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。