diff --git a/.forgejo/workflows/docs.yml b/.forgejo/workflows/docs.yml index 23d17a0..9ec59a1 100644 --- a/.forgejo/workflows/docs.yml +++ b/.forgejo/workflows/docs.yml @@ -28,7 +28,7 @@ jobs: else export SITE_URL="https://packwizjs.csw.im" fi - bun docs --hostedBaseUrl $SITE_URL --useHostedBaseUrlForAbsoluteLinks true + bun docs --loglevel verbose --hostedBaseUrl $SITE_URL --useHostedBaseUrlForAbsoluteLinks true - name: Deploy documentation to Meli run: | GREEN='\033[0;32m' @@ -40,7 +40,7 @@ jobs: echo "${YELLOW}Deploying to ${BLUE}Meli ${YELLOW}on branch ${GREEN}$CI_ACTION_REF_NAME_SLUG${YELLOW}...\n" - npx -p "@getmeli/cli" meli upload ./docs/html \ + npx -p "@getmeli/cli" meli upload ./.generated_docs/html \ --url "https://meli.csw.im" \ --site "${{ vars.MELI_SITE_ID }}" \ --token "${{ secrets.MELI_SITE_SECRET }}" \ diff --git a/.gitignore b/.gitignore index 43208ea..482ae05 100644 --- a/.gitignore +++ b/.gitignore @@ -178,4 +178,4 @@ dist .direnv/ # Documentation -docs/ +.generated_docs/ diff --git a/README.md b/README.md index af44655..0b1b14b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # PackwizJS +[![Documentation](https://packwizjs.csw.im/coverage.svg)](https://packwizjs.csw.im) + A simple JavaScript module to parse the contents of Packwiz index files. ## Installation diff --git a/bun.lock b/bun.lock index 5c0e699..b756402 100644 --- a/bun.lock +++ b/bun.lock @@ -11,6 +11,7 @@ "devDependencies": { "@getmeli/cli": "1.2.0", "@types/bun": "latest", + "@typhonjs-typedoc/ts-lib-docs": "^2024.12.25", "@typhonjs-typedoc/typedoc-theme-dmt": "0.3.1", "eslint": "9.20.0", "eslint-config-standard": "17.1.0", @@ -84,6 +85,8 @@ "@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw=="], + "@typhonjs-typedoc/ts-lib-docs": ["@typhonjs-typedoc/ts-lib-docs@2024.12.25", "", { "peerDependencies": { "typedoc": ">=0.25.0 || 0.26.x || 0.27.x || 0.28.x || 0.29.x || 0.30.x || 0.31.x" } }, "sha512-3yC+j9Sp1kLdgbiV9fTeeYZFugmuZQoUBFzZpUP5iK9Yj0oP+1ZvBw6CDdcqEjXOMO44teQZhfuhAlDNT6Pujg=="], + "@typhonjs-typedoc/typedoc-theme-dmt": ["@typhonjs-typedoc/typedoc-theme-dmt@0.3.1", "", { "dependencies": { "cheerio": "^1.0.0" }, "peerDependencies": { "typedoc": ">=0.27.3 <0.28" } }, "sha512-f0nRR0ZF+tJ0KqCTfBwidS+JpaKPWVHftnNN51zlzm8BnQsaJ0MnVmN2vpdpPXTpZJgQuwZ1Y/NDV9ALqHPI7g=="], "acorn": ["acorn@8.14.0", "", { "bin": { "acorn": "bin/acorn" } }, "sha512-cl669nCJTZBsL97OF4kUQm5g5hC2uihk0NxY3WENAC0TYdILVkAyHymAntgxGkl7K+t0cXIrH5siy5S4XkFycA=="], diff --git a/package.json b/package.json index 95c50e9..2c5e4d6 100644 --- a/package.json +++ b/package.json @@ -8,12 +8,13 @@ "devDependencies": { "@getmeli/cli": "1.2.0", "@types/bun": "latest", + "@typhonjs-typedoc/ts-lib-docs": "^2024.12.25", + "@typhonjs-typedoc/typedoc-theme-dmt": "0.3.1", "eslint": "9.20.0", "eslint-config-standard": "17.1.0", "typedoc": "0.27.7", - "typedoc-plugin-markdown": "4.4.1", "typedoc-plugin-coverage": "3.4.1", - "@typhonjs-typedoc/typedoc-theme-dmt": "0.3.1" + "typedoc-plugin-markdown": "4.4.1" }, "peerDependencies": { "typescript": "^5.0.0" diff --git a/typedoc.json b/typedoc.json index 919e0bc..4c52387 100644 --- a/typedoc.json +++ b/typedoc.json @@ -5,7 +5,7 @@ "outputs": [ { "name": "html", - "path": "./docs/html", + "path": "./.generated_docs/html", "options": { "navigation": { "includeCategories": true, @@ -34,9 +34,12 @@ "style": "compact", }, "sourceLinkTemplate": "https://c.csw.im/GalacticFactory/PackwizJS/src/commit/{gitRevision}/{path}#L{line}", + "coverageLabel": "Documentation Coverage", + "coverageOutputType": "all", "plugin": [ "typedoc-plugin-coverage", - "@typhonjs-typedoc/typedoc-theme-dmt" + "@typhonjs-typedoc/typedoc-theme-dmt", + "@typhonjs-typedoc/ts-lib-docs" ], "categorizeByGroup": true }