Skip to content

Commit d0f6303

Browse files
authored
Improve documentation generation workflow. (#1253)
1 parent a816f29 commit d0f6303

File tree

3 files changed

+2
-4
lines changed

3 files changed

+2
-4
lines changed

β€Ž.github/workflows/update-docs.yml

-3
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,6 @@ jobs:
2222
- name: Build documentation
2323
run: npm run docs
2424

25-
- name: Regenerate CNAME file
26-
run: echo docs.universalviewer.io > docs/CNAME
27-
2825
- name: Auto-commit fixes
2926
uses: EndBug/add-and-commit@v9
3027
with:

β€Žpackage.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"build-es": "node ./esbuild.mjs",
2424
"build-tsc": "tsc --skipLibCheck --module CommonJS --esModuleInterop --declarationDir ./dist/cjs --declaration --outDir ./dist/cjs -p . && npm run copy-files",
2525
"copy-files": "copyfiles -u 1 src/**/*.svg dist/cjs && copyfiles -u 1 src/**/*.gif dist/cjs && copyfiles -u 1 src/**/*.less dist/cjs && copyfiles -u 1 src/extensions/**/*.less dist/cjs && copyfiles -u 1 src/**/*.css dist/cjs",
26-
"docs": "typedoc --plugin typedoc-plugin-missing-exports --gitRevision dev",
26+
"docs": "typedoc --plugin typedoc-plugin-missing-exports ; echo docs.universalviewer.io > docs/CNAME",
2727
"test": "jest",
2828
"prepublishOnly": "npm run build && npm run build-tsc && npm run build-es"
2929
},

β€Žtypedoc.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"entryPoints": ["src/content-handlers/iiif/Docs.ts"],
3+
"sourceLinkTemplate": "https://github.com/UniversalViewer/universalviewer/blob/dev/{path}#L{line}",
34
"out": "docs"
45
}

0 commit comments

Comments
Β (0)