Skip to main content
Version: 12.3.0

🔌 Offline Access

Progressive Web App​

Progressive Web Applications can be installed using Chrome browser.

Click on the icon in the address bar to install the application as standalone with offline caching.

info

You can install App Icon SSE Docs and 👁️‍🗨️ Visualisation Online as PWAs.

Because both applications are hosted under the same domain, you will need to install first the 👁️‍🗨️ Visualisation Online module then App Icon SSE Docs.

📤 Export Documentation​

warning

An active internet connection is necessary to retrieve data for exporting.

note

Certain hypertext links may not be converted.

Use the commands below to export the entire documentation to PDF.

To download the current 12.3.0 version of the documentation, execute:

npx docs-to-pdf \
--initialDocURLs="https://sound-scape-explorer.github.io/docs/12.3.0" \
--contentSelector="article" \
--paginationSelector="a.pagination-nav__link.pagination-nav__link--next" \
--excludeSelectors=".margin-vert--xl a,[class^='tocCollapsible'],.breadcrumbs,.theme-edit-this-page" \
--coverImage="https://sound-scape-explorer.github.io/img/logo.png" \
--cssStyle=":root{background: transparent}" \
--coverTitle="SoundScapeExplorer Docs 12.3.0" \
--outputPDFFilename="SoundScapeExplorer-docs-12.3.0.pdf"

For the upcoming unreleased version, execute:

npx docs-to-pdf \
--initialDocURLs="https://sound-scape-explorer.github.io/docs/next" \
--contentSelector="article" \
--paginationSelector="a.pagination-nav__link.pagination-nav__link--next" \
--excludeSelectors=".margin-vert--xl a,[class^='tocCollapsible'],.breadcrumbs,.theme-edit-this-page" \
--coverImage="https://sound-scape-explorer.github.io/img/logo.png" \
--cssStyle=":root{background: transparent}" \
--coverTitle="SoundScapeExplorer Docs Next" \
--outputPDFFilename="SoundScapeExplorer-docs-next.pdf"

📤 Export Blog​

warning

An active internet connection is necessary to retrieve data for exporting.

Execute the command below to export the blog content to PDF:

npx docs-to-pdf \
--initialDocURLs="https://sound-scape-explorer.github.io/blog/index" \
--contentSelector="article" \
--paginationSelector="a.pagination-nav__link.pagination-nav__link--next" \
--excludeSelectors=".margin-vert--xl a,[class^='tocCollapsible'],.breadcrumbs,.theme-edit-this-page" \
--coverImage="https://sound-scape-explorer.github.io/img/logo.png" \
--cssStyle=":root{background: transparent}" \
--coverTitle="SoundScapeExplorer Blog 2024-8-16" \
--outputPDFFilename="SoundScapeExplorer-blog-2024-8-16.pdf"