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' adept'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 ye have to)
  • Us'ble offline, no external dependencies
  • Us'ble from yer local file system via file:// protocol
  • Support fer Internet Explorer 11
• Configur'ble them'n an' visuals
  • Configur'ble brand images
  • Automatic switch fer light/dark variant dependend 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
  • Tagg'n support
  • Hidden planks
  • Unlimited nested menu dependend on yer ship structure
  • Navigat'n buttons dependend on yer ship structure
  • Configur'ble shortcut links
• Multi language support
  • Full support fer languages written right t' left
  • Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
  • Search support fer mixed language rrrambl'n
• Additional Marrrkdown features
  • Support fer GFM (GitHub Flavored Marrrkdown
  • Image styl'n like siz'n, shadow, border an' alignment
  • Image lightbox
• Shorrrtcodes galore
  • Display files attached t' plank bundles
  • 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
  • Reveal ye site’s configurat'n parameter
  • Swagger UI fer yer OpenAPI Specificat'ns
  • 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' button displayed on top right o' each plank. Yer changes will be deployed automatically once they were reviewed. This requires a GitHub account.

Ye be most welcome t' contribute bugfixes or even new features t' th' source code by mak'n pull requests t' th' official repository via GitHub. Check th' Please contribut'n guidelines first before mak'n any changes.

License

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

Credits

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