Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/assets/icons.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/assets/icons.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/assets/main.js

Large diffs are not rendered by default.

17 changes: 5 additions & 12 deletions docs/assets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -504,15 +504,8 @@
body {
background: var(--color-background);
font-family:
-apple-system,
BlinkMacSystemFont,
"Segoe UI",
"Noto Sans",
Helvetica,
Arial,
sans-serif,
"Apple Color Emoji",
"Segoe UI Emoji";
-apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans",
Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
font-size: 16px;
color: var(--color-text);
margin: 0;
Expand Down Expand Up @@ -1602,9 +1595,9 @@
.container-main {
grid-template-columns:
minmax(0, 1fr) minmax(0, 2.5fr) minmax(
0,
20rem
);
0,
20rem
);
grid-template-areas: "sidebar content toc";
}

Expand Down
25 changes: 17 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ <h1 align="center" style="width: 60%; margin-left: auto; margin-right: auto;">Un
</p>
<p align="center"><a href="https://docs.google.com/forms/d/e/1FAIpQLSeHLD0kng5aXvGFsNN_tJGsZMTnp08Hv2F6kdGsJRb6bT0NWw/viewform" rel="nofollow"><strong>#</strong> Slack
</a> &nbsp;&nbsp;&nbsp;&nbsp;<a href="https://bsky.app/profile/universalviewer.io"> <strong>@</strong> Bluesky</a> &nbsp;&nbsp;&nbsp;&nbsp;<a href="https://x.com/universalviewer"> <strong>@</strong> X</a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://glammr.us/@universalviewer"> <strong>@</strong> Mastodon </a>&nbsp;&nbsp;&nbsp;&nbsp; <a href="https://github.com/UniversalViewer/universalviewer/wiki"> History of the UV </a> </p>
<h1 id="the-universal-viewer-uv-is-a-community-developed-open-source-project-our-mission-is-to-help-you-share-your-content-with-the-world" class="tsd-anchor-link">The Universal Viewer (UV) is a community-developed open source project. Our mission is to help you share your content with the world<a href="#the-universal-viewer-uv-is-a-community-developed-open-source-project-our-mission-is-to-help-you-share-your-content-with-the-world" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>The UV software can display images, 3D files and PDFs, play audio and video files, and more.</p>
<h1 id="the-universal-viewer-uv-is-a-community-developed-open-source-project-our-mission-is-to-help-you-share-your-content-with-the-world" class="tsd-anchor-link">The Universal Viewer (UV) is a community-developed open source project. Our mission is to help you share your content with the world<a href="#the-universal-viewer-uv-is-a-community-developed-open-source-project-our-mission-is-to-help-you-share-your-content-with-the-world" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1>
<p>The UV software can display images, 3D files and PDFs, play audio and video files, and more.</p>
<br/>
<pre><code>npm install universalviewer --save
</code></pre>
Expand All @@ -37,18 +38,21 @@ <h1 id="the-universal-viewer-uv-is-a-community-developed-open-source-project-our
<li><a href="#-accessibility-statement"><strong>Accessibility Statement</strong></a></li>
<li><a href="#-license"><strong>License</strong></a></li>
</ul>
<h2 id="🌐-website" class="tsd-anchor-link">🌐 Website<a href="#🌐-website" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
<h2 id="🌐-website" class="tsd-anchor-link">🌐 Website<a href="#🌐-website" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<ul>
<li><a href="https://universalviewer.io/">Visit Universal Viewer website</a></li>
<li><a href="https://uv-v4.netlify.app">Visit the stable UV demo page</a> to try out the latest stable version of the Viewer (UV4) with sample items.</li>
<li><a href="https://universalviewer.dev">Visit the dev branch UV demo page</a> to try out the latest 'bleeding edge' dev branch code for UV4.</li>
<li><a href="https://uv-v3.netlify.app">View sample items in version 3 of the Universal Viewer</a></li>
</ul>
<h2 id="📖-getting-started" class="tsd-anchor-link">📖 Getting Started<a href="#📖-getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>See the <a href="https://github.com/UniversalViewer/universalviewer/wiki/UV-Examples">examples</a> for how to use the UV in various scenarios.</p>
<h2 id="📖-getting-started" class="tsd-anchor-link">📖 Getting Started<a href="#📖-getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>See the <a href="https://github.com/UniversalViewer/universalviewer/wiki/UV-Examples">examples</a> for how to use the UV in various scenarios.</p>
<p>Read the technical <a href="https://docs.universalviewer.io/modules.html">docs</a> to learn more about the code and available configuration options.</p>
<p>Read the <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/manual/index.md">manual</a> for information on using, configuring, and developing for the UV.</p>
<p><a id="feedback"></a>
<a id="contributing"></a></p>
<h2 id="📣-contributing-and-giving-feedback" class="tsd-anchor-link">📣 Contributing and Giving Feedback<a href="#📣-contributing-and-giving-feedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>An active, collaborative community of testers, developers and institutional users has grown around the Universal Viewer. Read this <a href="https://blogs.bl.uk/digital-scholarship/2024/11/working-together-the-community-sprint-experience-.html">blog post about a recent 'community sprint'</a> to find out more about how we're working together.</p>
<h2 id="📣-contributing-and-giving-feedback" class="tsd-anchor-link">📣 Contributing and Giving Feedback<a href="#📣-contributing-and-giving-feedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>An active, collaborative community of testers, developers and institutional users has grown around the Universal Viewer. Read this <a href="https://blogs.bl.uk/digital-scholarship/2024/11/working-together-the-community-sprint-experience-.html">blog post about a recent 'community sprint'</a> to find out more about how we're working together.</p>
<p>Talking to active contributors and sponsors is a great way to find out what the community is currently focusing on, and where help is needed:</p>
<ul>
<li>Join the discussion on <a href="http://universalviewer.io/#contact">Slack</a></li>
Expand All @@ -69,9 +73,14 @@ <h2 id="📣-contributing-and-giving-feedback" class="tsd-anchor-link">📣 Cont
<li>Could not find an issue? Look for bugs, typos, and missing features.</li>
</ul>
<p><a id="sponsors"></a></p>
<h2 id="🏅-contributors-and-sponsors" class="tsd-anchor-link">🏅 Contributors and Sponsors<a href="#🏅-contributors-and-sponsors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="individual-contributors" class="tsd-anchor-link">Individual contributors<a href="#individual-contributors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><a href="https://github.com/UniversalViewer/universalviewer/graphs/contributors"><img src="https://opencollective.com/universalviewer/contributors.svg?width=890&amp;button=false" alt="Individual contributors" title="Individual contributors"></a></p>
<h3 id="institutional-contributors" class="tsd-anchor-link">Institutional contributors<a href="#institutional-contributors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><a href="https://opencollective.com/universalviewer#sponsor">Become a sponsor</a> and join our <a href="https://github.com/UniversalViewer/universalviewer/wiki/Steering-Group">Steering Group</a> to help guide how our sponsorship funds are allocated.</p>
<h2 id="🏅-contributors-and-sponsors" class="tsd-anchor-link">🏅 Contributors and Sponsors<a href="#🏅-contributors-and-sponsors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<h3 id="individual-contributors" class="tsd-anchor-link">Individual contributors<a href="#individual-contributors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>
<p><a href="https://github.com/UniversalViewer/universalviewer/graphs/contributors"><img src="https://opencollective.com/universalviewer/contributors.svg?width=890&amp;button=false" alt="Individual contributors" title="Individual contributors"></a></p>
<h3 id="institutional-contributors" class="tsd-anchor-link">Institutional contributors<a href="#institutional-contributors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>
<p><a href="https://opencollective.com/universalviewer#sponsor">Become a sponsor</a> and join our <a href="https://github.com/UniversalViewer/universalviewer/wiki/Steering-Group">Steering Group</a> to help guide how our sponsorship funds are allocated.</p>
<p><img src="https://raw.githubusercontent.com/UniversalViewer/assets/master/contributors.jpg" alt="Institutional contributors" title="Institutional contributors"></p>
<h2 id="📖-accessibility-statement" class="tsd-anchor-link">📖 Accessibility Statement<a href="#📖-accessibility-statement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Read our <a href="https://github.com/UniversalViewer/universalviewer/wiki/Accessibility-Statement-for-the-Universal-Viewer">Accessibility Statement</a></p>
<h2 id="📖-license" class="tsd-anchor-link">📖 License<a href="#📖-license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The Universal Viewer is released under the <a href="https://github.com/UniversalViewer/universalviewer/blob/master/LICENSE.txt">MIT license</a>.</p>
<h2 id="📖-accessibility-statement" class="tsd-anchor-link">📖 Accessibility Statement<a href="#📖-accessibility-statement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>Read our <a href="https://github.com/UniversalViewer/universalviewer/wiki/Accessibility-Statement-for-the-Universal-Viewer">Accessibility Statement</a></p>
<h2 id="📖-license" class="tsd-anchor-link">📖 License<a href="#📖-license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>The Universal Viewer is released under the <a href="https://github.com/UniversalViewer/universalviewer/blob/master/LICENSE.txt">MIT license</a>.</p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#the-universal-viewer-uv-is-a-community-developed-open-source-project-our-mission-is-to-help-you-share-your-content-with-the-world"><span>The <wbr/>Universal <wbr/>Viewer (<wbr/>UV) is a community-<wbr/>developed open source project. <wbr/>Our mission is to help you share your content with the world</span></a><ul><li><a href="#🌐-website"><span>🌐 <wbr/>Website</span></a></li><li><a href="#📖-getting-started"><span>📖 <wbr/>Getting <wbr/>Started</span></a></li><li><a href="#📣-contributing-and-giving-feedback"><span>📣 <wbr/>Contributing and <wbr/>Giving <wbr/>Feedback</span></a></li><li><a href="#🏅-contributors-and-sponsors"><span>🏅 <wbr/>Contributors and <wbr/>Sponsors</span></a></li><li><ul><li><a href="#individual-contributors"><span>Individual contributors</span></a></li><li><a href="#institutional-contributors"><span>Institutional contributors</span></a></li></ul></li><li><a href="#📖-accessibility-statement"><span>📖 <wbr/>Accessibility <wbr/>Statement</span></a></li><li><a href="#📖-license"><span>📖 <wbr/>License</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">universalviewer</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Loading