From 670d0fd7749fadd4fad3071111d654fbf0796b91 Mon Sep 17 00:00:00 2001 From: LinkunGao Date: Thu, 5 Oct 2023 23:51:09 +1300 Subject: [PATCH] update readme and action --- .github/workflows/algolia.yaml | 4 +++- README.md | 4 ++-- docs/source/release/release.md | 10 +++++----- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/.github/workflows/algolia.yaml b/.github/workflows/algolia.yaml index 4053d3d..2f8fadc 100644 --- a/.github/workflows/algolia.yaml +++ b/.github/workflows/algolia.yaml @@ -12,7 +12,9 @@ jobs: run: cd apidocs - name: Get the content of algolia.json as config id: algolia_config - run: echo "config=$(cat crawlerConfig.json | jq -r tostring)" >> $GITHUB_OUTPUT + run: | + cd apidocs/ + echo "config=$(cat crawlerConfig.json | jq -r tostring)" >> $GITHUB_OUTPUT - name: Push indices to Algolia uses: signcl/docsearch-scraper-action@master env: diff --git a/README.md b/README.md index 2950995..9cf8e55 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# copper3d_visualisation +# copper3d [![NPM Package][npm]][npm-url] [![Read the Docs][readthedocs]][readthedocs-url] @@ -93,7 +93,7 @@ function loadModel(url, name) { --- -[npm]: https://img.shields.io/npm/v/copper3d_visualisation +[npm]: https://img.shields.io/npm/v/copper3d [npm-url]: https://www.npmjs.com/package/copper3d [readthedocs]: https://img.shields.io/readthedocs/copper3d_visualisation [readthedocs-url]: https://copper3d-visualisation.readthedocs.io/en/latest/ diff --git a/docs/source/release/release.md b/docs/source/release/release.md index 8e56baa..cc8e5e3 100644 --- a/docs/source/release/release.md +++ b/docs/source/release/release.md @@ -1875,7 +1875,7 @@ sceneIn?.loadNrrd(url, loadBar1, false, funa, opts); copperScene.loadOBJ(url: string, callback?: (mesh: THREE.Group) => void, opts?:{color:string}); ``` -# Release v1.15.20 +## Release v1.15.20 - export `throttle` function @@ -1883,7 +1883,7 @@ sceneIn?.loadNrrd(url, loadBar1, false, funa, opts); throttle(callback: (event: MouseEvent) => void, wait: number): (event: MouseEvent) => void ``` -# Release v1.15.21 +## Release v1.15.21 - Optimise Nrrd_tools GUI function - Changed their name @@ -1913,11 +1913,11 @@ throttle(callback: (event: MouseEvent) => void, wait: number): (event: MouseEven nrrdTools.setPencilIconUrls(urls); ``` -# Release v1.15.22 +## Release v1.15.22 - add a getSphereData in nrrdTools draw function - for this function we can get the sphere raduis and the sphere origin in mm. -# Release v1.15.23 +## Release v1.15.23 -- fixed the cursor not center issue. \ No newline at end of file +- fixed the cursor not center issue.