@ts-for-gir/generator-html-doc 4.0.0-beta.21 → 4.0.0-beta.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -2
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -16,5 +16,18 @@
|
|
|
16
16
|
<img src="https://raw.githubusercontent.com/gjsify/ts-for-gir/main/.github/feeling.gif" />
|
|
17
17
|
</p>
|
|
18
18
|
|
|
19
|
-
# Generator
|
|
20
|
-
|
|
19
|
+
# HTML Documentation Generator
|
|
20
|
+
|
|
21
|
+
## Status: Not Yet Implemented
|
|
22
|
+
|
|
23
|
+
This package currently serves as a placeholder and basic framework for implementing an HTML documentation generator based on GIR types. It does not contain actual functionality yet.
|
|
24
|
+
|
|
25
|
+
## Purpose
|
|
26
|
+
|
|
27
|
+
The intended purpose of this package is to provide a way to generate HTML documentation from GObject introspection data, similar to how the `generator-typescript` package generates TypeScript definitions. When implemented, it would allow for generating human-readable API documentation websites.
|
|
28
|
+
|
|
29
|
+
## Implementation
|
|
30
|
+
|
|
31
|
+
This package implements the `Generator` interface from `@ts-for-gir/generator-base` but its methods currently throw "Not implemented" errors. It provides the basic structure needed for anyone who wants to implement a full HTML documentation generator for GObject introspection types.
|
|
32
|
+
|
|
33
|
+
If you're interested in implementing this feature, contributions are welcome! Feel free to use this package as a starting point for building a complete HTML documentation generator.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ts-for-gir/generator-html-doc",
|
|
3
|
-
"version": "4.0.0-beta.
|
|
3
|
+
"version": "4.0.0-beta.23",
|
|
4
4
|
"description": "HTML Documentation generator for ts-for-gir",
|
|
5
5
|
"module": "lib/index.js",
|
|
6
6
|
"main": "lib/index.js",
|
|
@@ -34,18 +34,18 @@
|
|
|
34
34
|
"generator"
|
|
35
35
|
],
|
|
36
36
|
"devDependencies": {
|
|
37
|
-
"@types/node": "^22.13.
|
|
38
|
-
"@typescript-eslint/eslint-plugin": "^8.
|
|
39
|
-
"@typescript-eslint/parser": "^8.
|
|
40
|
-
"eslint": "^9.
|
|
41
|
-
"eslint-config-prettier": "^10.
|
|
37
|
+
"@types/node": "^22.13.11",
|
|
38
|
+
"@typescript-eslint/eslint-plugin": "^8.27.0",
|
|
39
|
+
"@typescript-eslint/parser": "^8.27.0",
|
|
40
|
+
"eslint": "^9.22.0",
|
|
41
|
+
"eslint-config-prettier": "^10.1.1",
|
|
42
42
|
"eslint-plugin-prettier": "^5.2.3",
|
|
43
|
-
"prettier": "^3.5.
|
|
43
|
+
"prettier": "^3.5.3",
|
|
44
44
|
"rimraf": "^6.0.1",
|
|
45
|
-
"typescript": "^5.
|
|
45
|
+
"typescript": "^5.8.2"
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
|
-
"@ts-for-gir/generator-base": "^4.0.0-beta.
|
|
49
|
-
"@ts-for-gir/lib": "^4.0.0-beta.
|
|
48
|
+
"@ts-for-gir/generator-base": "^4.0.0-beta.23",
|
|
49
|
+
"@ts-for-gir/lib": "^4.0.0-beta.23"
|
|
50
50
|
}
|
|
51
51
|
}
|