Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.05 KB

index.md

File metadata and controls

50 lines (34 loc) · 1.05 KB
Raw
layout title navigation
page
Overview
1

Millidocs Theme

Simple documentation theme for Jekyll featuring Milligram CSS framework, PrismJS syntax highlighter and LunrJS search.

One of the core features is a full text client side search and full responsiveness. It has zero dependencies with other gems and should be easily build with Github.

Installation

Add this line to your Jekyll site's Gemfile:

gem "millidocs"

Adapt your Jekyll site config _config.yml:

  title: My Docs Page Title
  description: MY description
  url: "https://base/url/site"
  theme: millidocs

  markdown: kramdown
  kramdown:
    syntax_highlighter_opts:
      disable : true

  exclude:
    - Gemfile
    - Gemfile.lock
    - README.md

And then execute:

$ bundle

Or install it yourself as:

$ gem install millidocs

Available Layouts

This theme is made for pages only and doesn't support posts by default. So the only available layouts are default and page.