@hia-doc/htmdoc-producer 0.1.0
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/LICENSE +21 -0
- package/README.md +15 -0
- package/package.json +30 -0
- package/src/index.mjs +30 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 HIA
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# @hia-doc/htmdoc-producer
|
|
2
|
+
|
|
3
|
+
Thin `documentation-producer@0.1.0-draft` adapter for HTMDoc.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
npm install @hia-doc/htmdoc-producer
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import htmdocProducer from "@hia-doc/htmdoc-producer";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
The producer delegates to `@hia-doc/htmdoc-runner`, so standalone and HIA
|
|
14
|
+
project builds use the same extraction and artifact pipeline. The producer is
|
|
15
|
+
loaded explicitly by an HIA project; it does not scan installed modules.
|
package/package.json
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@hia-doc/htmdoc-producer",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Documentation producer adapter for HTMDoc.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"keywords": ["documentation", "html", "producer", "htmdoc"],
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "git+https://github.com/mandolin/hia-htmdoc.git",
|
|
10
|
+
"directory": "packages/htmdoc-producer"
|
|
11
|
+
},
|
|
12
|
+
"bugs": { "url": "https://github.com/mandolin/hia-htmdoc/issues" },
|
|
13
|
+
"homepage": "https://github.com/mandolin/hia-htmdoc/tree/main/packages/htmdoc-producer#readme",
|
|
14
|
+
"type": "module",
|
|
15
|
+
"exports": {
|
|
16
|
+
".": "./src/index.mjs"
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"src",
|
|
20
|
+
"README.md",
|
|
21
|
+
"LICENSE"
|
|
22
|
+
],
|
|
23
|
+
"engines": {
|
|
24
|
+
"node": ">=20.19.0"
|
|
25
|
+
},
|
|
26
|
+
"publishConfig": { "access": "public" },
|
|
27
|
+
"dependencies": {
|
|
28
|
+
"@hia-doc/htmdoc-runner": "0.1.0"
|
|
29
|
+
}
|
|
30
|
+
}
|
package/src/index.mjs
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import {
|
|
2
|
+
HTMDOC_INPUT_KINDS,
|
|
3
|
+
HTMDOC_OUTPUT_KINDS,
|
|
4
|
+
HTMDOC_RUNNER_VERSION,
|
|
5
|
+
runHtmDoc
|
|
6
|
+
} from "@hia-doc/htmdoc-runner";
|
|
7
|
+
|
|
8
|
+
export const htmdocProducerDescriptor = Object.freeze({
|
|
9
|
+
contract: "documentation-producer",
|
|
10
|
+
contractVersion: "0.1.0-draft",
|
|
11
|
+
id: "htmdoc",
|
|
12
|
+
version: HTMDOC_RUNNER_VERSION,
|
|
13
|
+
displayName: "HTMDoc",
|
|
14
|
+
inputKinds: [...HTMDOC_INPUT_KINDS],
|
|
15
|
+
outputKinds: [...HTMDOC_OUTPUT_KINDS],
|
|
16
|
+
capabilities: {
|
|
17
|
+
sourceLinkage: true,
|
|
18
|
+
incremental: false,
|
|
19
|
+
watch: false
|
|
20
|
+
}
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
export const htmdocProducer = Object.freeze({
|
|
24
|
+
descriptor: htmdocProducerDescriptor,
|
|
25
|
+
produce(request, context = {}) {
|
|
26
|
+
return runHtmDoc(request, context);
|
|
27
|
+
}
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
export default htmdocProducer;
|