README.md

Middleman UIkit documentation template

Template for documentation pages styled with UIkit for Middleman.

Check demo or learn about customization and usage in documentation.

Features

Implemented

• layouts - landing, contents list and documentation
• breadcrumbs
• sidebar nav
• code snippets highlights
• two level navbar
• GitLab SSE ready
• optional right sidebar with links to second level heading
• next and previous links
• heading anchors

Planned

• search
• localization support

Usage

Installation

middleman init MY_PROJECT_FOLDER -T hajnyon/middleman-uikit-documentation-template

For installation details visit documentation.

Configuration

For configuration details visit documentation.

Got question?

Try FAQ first and issues second. You didn't find an answer? Reach the author or create an issue.

License

All parts of this project (see Credits section) as well as template itself are licensed under MIT.

Credits

• middleman
• middleman.com
• middleman-templates-blog
• middleman-syntax
• UIkit
• AnchorJS