<h2>Overview:</h2>
<p>The jekyll-rtd-theme is a documentation theme that is compatible with GitHub Pages. It is inspired by the sphinx-rtd-theme and refactored with @primer/css and github-pages dependencies. This theme allows users to generate documentation websites with the same files and folders from rundocs/starter-slim.</p>
<h2>Features:</h2>
<ul>
<li><strong>Shortcodes</strong>: Includes various shortcodes such as toasts card and mermaid for enhanced functionality.</li>
<li><strong>Pages Plugins</strong>: Supports plugins like emoji, gist, avatar, and mentions for added features on pages.</li>
<li><strong>Auto Generate Sidebar</strong>: Automatically generates a sidebar for easy navigation through the documentation.</li>
<li><strong>Attribute List Definitions</strong>: Includes attribute list definitions using Primer/css utilities and Font Awesome 4 for styling.</li>
<li><strong>Service Worker</strong>: Enables caching of the website's pages for improved performance.</li>
<li><strong>SEO</strong>: Provides SEO-related functionalities such as handling 404 errors, generating robots.txt and sitemap.xml files.</li>
<li><strong>Canonical Link</strong>: Supports Open Graph, Twitter Card, and Schema data for proper social media sharing and search engine optimization.</li>
</ul>


Rundocs

Jekyll Rtd Theme