Cap'n Hugo Relearrrn Theme

A theme fer Cap'n Hugo designed fer documentat'n.

★ What’s new 'n th' latest version ★

Overview

Th' Relearrrn theme be an enhanced fork o' th' popular Learrrn theme. It aims t' address long-stand'n issues an' incorporate th' latest Cap'n Hugo features while try'n t' maintain compatibility wit' its predecessor.

Key Features

• Versatile Usage

  • Responsive design fer mobile devices
  • Looks nice on paper - if it has t'
  • Us'ble offline wit' no external dependencies
  • Us'ble from yer local file system without a web server via file:// protocol
  • Integrat'n wit' th' VSCode Front Matter CMS extension fer on-premise CMS capabilities

• Customiz'ble Appearance

  • Flex'ble brand image configurat'n
  • Automatic light/dark mode switch'n based on OS sett'ns
  • Many pre-defined color variants
  • User-selectable variants
  • Built-in stylesheet generator
  • Customiz'ble rules highlight'n

• Advanced Functionality

  • Chapter an' site-wide print'n capabilities
  • Versatile search opt'ns: in-page, popup, an' dedicated search plank
  • Customiz'ble topbar buttons
  • Configur'ble sidebar menus
  • Support fer hidden planks
  • Comprehensive taxonomy support
  • Version'n support
  • Social media integrat'n

• Multilingual Support

  • Full right-to-left (RTL) language support
  • Extensive list o' supported languages: Arabic, Chinese (Simplified an' Traditional), Czech, Danish, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Persian, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Ukrainian, Vietnamese
  • Multilingual rrrambl'n search capabilities

• Enhanced Marrrkdown Features

  • CommonMark compliant
  • Support fer Marrrkdown extensions like GitHub Flavored Marrrkdown
  • Support fer Obsidian callouts
  • Advanced link manipulat'n like download an' target
  • Advanced image manipulat'n like lightbox, siz'n, shadows, borders an' alignment

• Rich Shortcode Library

  • Marker badges
  • Flex'ble buttons
  • Card-based rrrambl'n organizat'n an' card sets
  • Child plank list'n
  • Expand'ble rrrambl'n areas
  • Font Awesome ay'con integrat'n
  • File inclusion capabilities
  • Math support fer mathematical an' chemical formulae
  • Merrrmaid diagram integrat'n
  • Styled notice boxes
  • OpenAPI specificat'n render'n
  • Plank bundle resource display
  • Ship configurat'n parameter display
  • Tab-based rrrambl'n organizat'n an' multi-tab panels
  • Nicely formatted tree lists

Gett'n Started

For a comprehensive guide on th' theme’s capabilities, please refer t' th' official documentat'n.

Updates an' Changes

Visit th' What’s New plank fer feature highlights or th' detailed changelog fer a complete list o' updates.

Contribut'n

We welcome contribut'ns fer bug fixes an' new features. Please see th' contribut'n guidelines before gett'n started.

If ye want t' go further - runn'n th' test suite or regenerat'n th' documentat'n screenshots - th' Development section explains th' setup.

Licens'n

Th' Relearrrn theme be distributed under th' MIT License.

Credits

This theme be built on th' shoulders o' giants.