Fixes #1177.

lit · Jun 25, 2020 · 7f726d3 · 7f726d3
1 parent 3ada878
commit 7f726d3
Show file tree

Hide file tree

Showing 6 changed files with 76 additions and 152 deletions.
diff --git a/docs/_api/copy_api.sh b/docs/_api/copy_api.sh
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json
@@ -5,7 +5,7 @@
     "build": "npm run build:api && npm run build:site",
     "build:site": "eleventy",
     "build:site:watch": "eleventy --watch",
-    "build:api": "(cd _api && sh copy_api.sh) &&  typedoc --name \"lit-html API\" --readme _api/readme.md  --mode modules --theme _api/theme --tsconfig ../tsconfig.json --ignoreCompilerErrors --excludeNotExported --excludePrivate --out ./api --gaID UA-39334307-23 _api/tmp/lit-html.ts _api/tmp/lib/shady-render.ts",
+    "build:api": "typedoc ../src/lit-html.ts ../src/lib/shady-render.ts",
     "assets": "cp ../node_modules/prismjs/themes/prism-okaidia.css css/",
     "serve": "serve",
     "deploy": "npm run build && gcloud app deploy _site/app.yaml --project polymer-lit-html --no-promote"
@@ -19,7 +19,6 @@
     "markdown-it-attrs": "^3.0.1",
     "serve": "^11.3.0",
     "slugify": "^1.3.6",
-    "typedoc": "^0.13.0",
-    "typedoc-plugin-external-module-name": "^1.1.3"
+    "typedoc": "^0.17.0-3"
   }
 }
diff --git a/docs/typedoc.json b/docs/typedoc.json
@@ -0,0 +1,12 @@
+{
+  "readme": "./_api/readme.md",
+  "tsconfig": "../tsconfig.json",
+  "mode": "library",
+  "theme": "./_api/theme",
+  "excludeNotExported": true,
+  "excludePrivate": true,
+  "ignoreCompilerErrors": true,
+  "exclude":  ["**/*test*", "**/node_modules/!(lit-html)/**", "**/test/**"],
+  "out": "./api",
+  "gaID": "UA-39334307-23"
+}
diff --git a/src/lib/shady-render.ts b/src/lib/shady-render.ts
@@ -16,8 +16,7 @@
  * Module to add shady DOM/shady CSS polyfill support to lit-html template
  * rendering. See the [[render]] method for details.
  *
- * @module shady-render
- * @preferred
+ * @packageDocumentation
  */
 
 /**

diff --git a/src/lit-html.ts b/src/lit-html.ts
@@ -22,8 +22,7 @@
  * -  [[svg]]
  * -  [[render]]
  *
- * @module lit-html
- * @preferred
+ * @packageDocumentation
  */
 
 /**