Cap'n Hugo Relearrrn Theme

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

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

Motivat'n

Th' theme be a fork o' th' great Learrrn theme wit' th' aim o' fix'n long outstand'n bugs an' adapt'n t' latest Cap'n Hugo features. As far as poss'ble this theme tries t' be a drop-in replacement fer th' Learrrn theme.

Features

• Wide set o' usage scenarios
  • Responsive design fer mobile usage
  • Looks nice on paper (if it has to)
  • Us'ble offline, no external dependencies
  • Us'ble from yer local file system via file:// protocol
  • Support fer th' VSCode Front Matter extension fer on-premise CMS capabilities
  • Support fer Open Graph an' Twitter Cards
• Configur'ble them'n an' visuals
  • Configur'ble brand images
  • Automatic switch fer light/dark variant depend'n on yer OS sett'ns
  • Predefined light, dark an' color variants
  • User select'ble variants
  • Stylesheet generator
  • Configur'ble rules highlight'n
• Unique theme features
  • Print whole chapters or even th' complete ship
  • In plank search
  • Ship search
  • Dedicated search plank
  • Taxonomy support
  • Configur'ble topbar buttons
  • Unlimited nested menu items
  • Configur'ble shortcut links
  • Hidden planks
• Multi language support
  • Full support fer languages written right t' left
  • Avail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese
  • Search support fer mixed language rrrambl'n
• Additional Marrrkdown features
  • Support fer GFM (GitHub Flavored Markdown)
  • Image effects like siz'n, shadow, border an' alignment
  • Image lightbox
• Shorrrtcodes galore
  • Display resources contained 'n a plank bundle
  • Marker badges
  • Configur'ble buttons
  • List child planks
  • Expand areas t' reveal rrrambl'n
  • Font Awesome ay'cons
  • Inclusion o' other files
  • Math an' chemical formulae us'n MathJax
  • Merrrmaid diagrams fer flowcharts, sequences, gantts, pie, etc.
  • Colorful boxes
  • OpenAPI specificat'ns us'n Swagger UI
  • Reveal ye site’s configurat'n parameter
  • Single tabbed panels an' multiple tabbed panels

Support

T' get support, feel free t' open a new discussion topic or issue report 'n th' official repository on GitHub.

Contribut'ns

Feel free t' contribute t' this documentat'n by just click'n th' edit button displayed on top right o' each plank.

Ye be most welcome t' contribute bugfixes or new features by mak'n pull requests t' th' official repository. Check th' contribut'n guidelines first before start'n.

License

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

Credits

This theme would not be poss'ble without th' work o' many others.