Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@demiankatz
demiankatz committed Jan 22, 2025
1 parent ee7495a commit 8851c7b
Show file tree
Hide file tree
Showing 86 changed files with 200 additions and 199 deletions.
36 changes: 18 additions & 18 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ <h1 align="center" style="width: 60%; margin-left: auto; margin-right: auto;">Un
</code></pre>
<br/>
<blockquote>
<p>Please note that UV v4 is designed to work on <a href="https://www.w3.org/2001/tag/doc/evergreen-web/" target="_blank" class="external">evergreen browsers</a>. If you need IE11 support, please use <a href="https://github.com/UniversalViewer/universalviewer/tree/v3" target="_blank" class="external">UV v3</a>.
Microsoft no longer supports IE11, and it <a href="https://blogs.windows.com/windowsexperience/2021/05/19/the-future-of-internet-explorer-on-windows-10-is-in-microsoft-edge/" target="_blank" class="external">reached end-of-life on June 15 2022</a>.</p>
<p>Please note that UV v4 is designed to work on <a href="https://www.w3.org/2001/tag/doc/evergreen-web/">evergreen browsers</a>. If you need IE11 support, please use <a href="https://github.com/UniversalViewer/universalviewer/tree/v3">UV v3</a>.
Microsoft no longer supports IE11, and it <a href="https://blogs.windows.com/windowsexperience/2021/05/19/the-future-of-internet-explorer-on-windows-10-is-in-microsoft-edge/">reached end-of-life on June 15 2022</a>.</p>
</blockquote>
<br/>
<ul>
Expand All @@ -38,31 +38,31 @@ <h1 align="center" style="width: 60%; margin-left: auto; margin-right: auto;">Un
<li><a href="#-feedback"><strong>Feedback</strong></a></li>
</ul>
<a id="🌐-website" class="tsd-anchor"></a><h2 class="tsd-anchor-link">🌐 Website<a href="#🌐-website" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
<li><a href="https://universalviewer.io/" target="_blank" class="external">Visit Universal Viewer website</a></li>
<li><a href="https://uv-v4.netlify.app" target="_blank" class="external">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" target="_blank" class="external">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" target="_blank" class="external">View sample items in version 3 of the Universal Viewer</a></li>
<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>
<a id="📖-getting-started" class="tsd-anchor"></a><h2 class="tsd-anchor-link">📖 Getting Started<a href="#📖-getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>See the <a href="https://github.com/UniversalViewer/universalviewer/wiki/UV-Examples" target="_blank" class="external">examples</a> for how to use the UV in various scenarios.</p>
<p>Read the technical <a href="https://docs.universalviewer.io/modules.html" target="_blank" class="external">docs</a> to learn more about the code and available configuration options.</p>
<a id="📖-getting-started" class="tsd-anchor"></a><h2 class="tsd-anchor-link">📖 Getting Started<a href="#📖-getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><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>
<a id="💻-contributing" class="tsd-anchor"></a><h2 class="tsd-anchor-link">💻 Contributing<a href="#💻-contributing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Read below to learn how to take part in improving the UV:</p>
<ul>
<li>Fork the repository and <a href="#-getting-started">run the examples from source</a></li>
<li>Get familiar with <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/CODE_OF_CONDUCT.md" target="_blank" class="external">Code of Conduct</a></li>
<li>Read our <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/CONTRIBUTING.md" target="_blank" class="external">guide to contributing</a></li>
<li>Read our <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/GOVERNANCE.md" target="_blank" class="external">governance document</a> to learn more about roles and responsibilities, support, membership, and the decision making process.</li>
<li>Find an <a href="https://github.com/UniversalViewer/universalviewer/issues" target="_blank" class="external">issue</a> to work on and submit a pull request</li>
<li>Get familiar with <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/CODE_OF_CONDUCT.md">Code of Conduct</a></li>
<li>Read our <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/CONTRIBUTING.md">guide to contributing</a></li>
<li>Read our <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/GOVERNANCE.md">governance document</a> to learn more about roles and responsibilities, support, membership, and the decision making process.</li>
<li>Find an <a href="https://github.com/UniversalViewer/universalviewer/issues">issue</a> to work on and submit a pull request</li>
<li>Could not find an issue? Look for bugs, typos, and missing features.</li>
</ul>
<p><img src="https://raw.githubusercontent.com/UniversalViewer/assets/master/contributors.jpg" alt="Contributors" title="Contributors"></p>
<p><a href="https://github.com/UniversalViewer/universalviewer/graphs/contributors"><img src="https://opencollective.com/universalviewer/contributors.svg?width=890&button=false" /></a></p>
<a id="🏅-sponsors" class="tsd-anchor"></a><h2 class="tsd-anchor-link">🏅 Sponsors<a href="#🏅-sponsors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><a href="https://opencollective.com/universalviewer#sponsor" target="_blank" class="external">Become a sponsor</a> and join our <a href="https://github.com/UniversalViewer/universalviewer/wiki/Steering-Group" target="_blank" class="external">Steering Group</a> to help guide how our sponsorship funds are allocated.</p>
<a id="📖-license" class="tsd-anchor"></a><h2 class="tsd-anchor-link">📖 License<a href="#📖-license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><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" target="_blank" class="external">MIT license</a>.</p>
<a id="📖-accessibility-statement" class="tsd-anchor"></a><h2 class="tsd-anchor-link">📖 Accessibility Statement<a href="#📖-accessibility-statement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><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" target="_blank" class="external">Accessibility Statement</a></p>
<a id="📣-feedback" class="tsd-anchor"></a><h2 class="tsd-anchor-link">📣 Feedback<a href="#📣-feedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Read below how to engage with the UV <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/COMMUNITY_TEAM.md" target="_blank" class="external">community</a>:</p>
<a id="🏅-sponsors" class="tsd-anchor"></a><h2 class="tsd-anchor-link">🏅 Sponsors<a href="#🏅-sponsors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><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>
<a id="📖-license" class="tsd-anchor"></a><h2 class="tsd-anchor-link">📖 License<a href="#📖-license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><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>
<a id="📖-accessibility-statement" class="tsd-anchor"></a><h2 class="tsd-anchor-link">📖 Accessibility Statement<a href="#📖-accessibility-statement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><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>
<a id="📣-feedback" class="tsd-anchor"></a><h2 class="tsd-anchor-link">📣 Feedback<a href="#📣-feedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Read below how to engage with the UV <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/COMMUNITY_TEAM.md">community</a>:</p>
<ul>
<li>Join the discussion on <a href="http://universalviewer.io/#contact" target="_blank" class="external">Slack</a>.</li>
<li>Ask a question, request a new feature and file a bug with <a href="https://github.com/universalviewer/universalviewer/issues/new" target="_blank" class="external">GitHub issues</a>.</li>
<li>Join the discussion on <a href="http://universalviewer.io/#contact">Slack</a>.</li>
<li>Ask a question, request a new feature and file a bug with <a href="https://github.com/universalviewer/universalviewer/issues/new">GitHub issues</a>.</li>
<li>Star the repository to show your support ⭐</li>
</ul>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#🌐-website"><span>🌐 <wbr/>Website</span></a><a href="#📖-getting-started"><span>📖 <wbr/>Getting <wbr/>Started</span></a><a href="#💻-contributing"><span>💻 <wbr/>Contributing</span></a><a href="#🏅-sponsors"><span>🏅 <wbr/>Sponsors</span></a><a href="#📖-license"><span>📖 <wbr/>License</span></a><a href="#📖-accessibility-statement"><span>📖 <wbr/>Accessibility <wbr/>Statement</span></a><a href="#📣-feedback"><span>📣 <wbr/>Feedback</span></a></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

0 comments on commit 8851c7b

Please sign in to comment.