refactor: polish docs

f3rno64 · Dec 21, 2023 · 6f414a9 · 6f414a9
1 parent c49daa0
commit 6f414a9
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 52 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.4.0](https://github.com/f3rno64/time-speak/compare/v1.3.3...v1.4.0) (2023-12-21)
+
 ### [1.3.3](https://github.com/f3rno64/time-speak/compare/v1.3.2...v1.3.3) (2023-12-14)
 
 ### [1.3.2](https://github.com/f3rno64/time-speak/compare/v1.3.1...v1.3.2) (2023-12-13)

diff --git a/docs/classes/InvalidInputError.html b/docs/classes/InvalidInputError.html
diff --git a/docs/functions/parse.html b/docs/functions/parse.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/modules.html b/docs/modules.html
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -20,7 +20,7 @@
     "date parser"
   ],
   "scripts": {
-    "docs": "rm -rf docs && npx typedoc --out docs src && cp LICENSE.md docs/LICENSE.md && cp CHANGELOG.md docs/CHANGELOG.md",
+    "docs": "npx typedoc --out docs src && cp LICENSE.md docs/LICENSE.md && cp CHANGELOG.md docs/CHANGELOG.md",
     "test": "NODE_PATH=./src NODE_ENV=test mocha",
     "test:coverage": "NODE_PATH=./src NODE_ENV=test nyc mocha",
     "test:watch": "NODE_PATH=./src NODE_ENV=test nyc mocha --watch",

diff --git a/tsconfig.json b/tsconfig.json
@@ -35,6 +35,11 @@
   },
 
   "typedocOptions": {
+    "githubPages": true,
+    "cacheBust": true,
+    "hideGenerator": true,
+    "searchInComments": true,
+    "cleanOutputDir": true,
     "entryPoints": ["src/index.ts"],
     "out": "docs"
   }