Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.51 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.51 KB

Musaeum

A clean and responsive Hugo theme for manuals and documentation

Musaeum is a clean and minimalistic theme with a focus on content and legibility. This theme is partly inspired by GitHub’s Markdown renderer and documentation pages.

Features

  • Extensive support for Markdown elements.
  • Navigation sidebar with support for arbitrarily nested sections.
  • Optional icons for important sections in the navigation sidebar.
  • Previous/next page links at the bottom of each page for continuous reading.
  • Optional links for suggesting improvements at the bottom of each page.

Configuration

Site Parameters

option description
githubDocumentationRepository URL of the corresponding GitHub repo. If set, each page will feature an edit this page button in the footer.

Page Parameters

option description
hidden Hides the page or section (and all its subpages) from the menu.
hideTableOfContents Hide table of contents at the end of list pages.
icon Path to an icon that will be displayed next to this page’s entry in the navigation sidebar.

Name

The name of this theme refers to the Musaeum at Alexandria (also called Mouseion), the institution housing the Library of Alexandria, the arguably most significant ancient library. In a way, this theme is to your documentation what the Musaeum was to the Library of Alexandria.