Skip to content

Commit e40c817

Browse files
committed
docs: add typedoc link to README
1 parent aa89cff commit e40c817

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@ esm and umd versions you can use for now.
9090

9191
[npm-pack-url]: https://storage.ubidev.net/marker-api-playground/lib/googlemaps-marker.tgz
9292

93+
## API Documentation
94+
95+
The API documentation generated by typedoc is available here:
96+
97+
[API Documentation](https://storage.ubidev.net/marker-api-playground/api-docs/)
98+
9399
## Core Concepts
94100

95101
One key design choice made here is to use dynamic properties instead of

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@
5151
"server:docs": "http-server ./dist/docs",
5252
"docs": "run-p watch:docs server:docs",
5353
"deploy:playground": "cd examples/playground && npm run deploy",
54-
"deploy:archive": "npm run clean && npm run build && npm pack --pack-destination ./dist && mv ./dist/googlemaps-marker*.tgz ./dist/googlemaps-marker.tgz && gsutil -m rsync -rc ./dist/ gs://storage.ubidev.net/marker-api-playground/lib/",
54+
"deploy:archive": "run-s clean build && npm pack --pack-destination ./dist && mv ./dist/googlemaps-marker*.tgz ./dist/googlemaps-marker.tgz && gsutil -m rsync -rc ./dist/ gs://storage.ubidev.net/marker-api-playground/lib/",
55+
"deploy:docs": "npm run build:docs && gsutil -m rsync -rc ./dist/docs gs://storage.ubidev.net/marker-api-playground/api-docs/",
5556
"deploy": "run-s deploy:*"
5657
},
5758
"devDependencies": {

0 commit comments

Comments
 (0)