We introduce the new Reader UI layout template that offers improved performance and a modern look. In this topic, you can find the list of advantages, the current limitations of the new template, and instructions on how to enable it on your portal.
How to Enable New Reader UI Template
- Go to Settings > Look & feel > Reader Interface.
-
Select the Next Reader UI layout template in the corresponding list:
- Save changes.
Advantages
The new template has several advantages in comparison to legacy templates:
- Faster page loading.
- Modern and visually appealing user interface.
- The interface is WCAG 2.2 AA-compliant.
- Better page indexing by search engines and AI agents since the hashbang technology is not used with this template.
- Support of built-in browser search (using the Ctrl+F keyboard shortcut).
- The topic progress bar on the top of the page.
- Automatically added breadcrumbs.
- Automatically added navigation links to the Previous and Next topics.
- The Back to top button.
- The content area of the API documentation is wider which makes it more convenient to work with it.
- Automatic highlighting of the current section in the In this topic list in the right sidebar.
Limitations
The following features are not currently supported in the new Reader UI:
- The subscribe feature.
- The version history for readers.
- Highlighting of the found search words in topics.
- Some of the Reader interface settings are not supported. Currently, the following settings are available: Portal Branding CSS, Portal Branding script, Selection color, Hover color, Show the 'Copy Markdown' button.
- The Modern template is applied only to the topic pages. The search page and user profile pages use the Clear Sky Reader UI template.
- Auto-topics for the API documentation with the legacy rendering engine. The Modern rendering engine, which is the default now, is supported.
- The Index keywords navigation.
- Only the English Reader interface language is supported.
- The Featured snippets option on the search page.
- Reader feedback widget.
-
Portal-wide Full-Text Search Settings.
- Commenting with GraphComment and Disqus integrations.
- Publication icons, the hide from publications list feature, and publications ordering from the publication basic settings.
- Switching between translations in different languages.
- Google Translate widget.
We're going to improve the current functionality and support the mentioned features in the future versions of this template.