Skip to content

Commit

Permalink
docs: add typedoc link to README
Browse files Browse the repository at this point in the history
  • Loading branch information
usefulthink committed Feb 22, 2023
1 parent aa89cff commit e40c817
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,12 @@ esm and umd versions you can use for now.

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

## API Documentation

The API documentation generated by typedoc is available here:

[API Documentation](https://storage.ubidev.net/marker-api-playground/api-docs/)

## Core Concepts

One key design choice made here is to use dynamic properties instead of
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@
"server:docs": "http-server ./dist/docs",
"docs": "run-p watch:docs server:docs",
"deploy:playground": "cd examples/playground && npm run deploy",
"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/",
"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/",
"deploy:docs": "npm run build:docs && gsutil -m rsync -rc ./dist/docs gs://storage.ubidev.net/marker-api-playground/api-docs/",
"deploy": "run-s deploy:*"
},
"devDependencies": {
Expand Down

0 comments on commit e40c817

Please sign in to comment.