- Quick Start
- Now compatible with Jekyll 3.x
- Two-column layout with scrolling sidebar content
- Ideal for websites that require master-detail view of content
Download the zip file or clone the BlackDoc repo.
$ git clone firstname.lastname@example.org:karloespiritu/BlackDoc.git mysite $ cd mysite
Make sure you have Ruby 2.0.0 or higher installed.
$ ruby --version ruby 2.x.x
Install bundler and install dependencies.
$ gem install bundler $ bundle install
Build and run your BlackDoc site.
$ jekyll serve
BlackDoc includes some customizable options, typically applied via classes on the
Create a list of nav links in the sidebar by assigning each Jekyll page the correct layout in the page's front-matter.
--- layout: page title: About ---
Why require a specific layout? Jekyll will return all pages, including the
atom.xml, and with an alphabetical sort order. To ensure the first link is Home, we exclude the
index.html page from this list by specifying the
Scrolling sidebar content
By default, BlackDoc includes a scrolling sidebar that will display your markdown files in alphabetical order.
BlackDoc ships with eight optional themes based on the base16 color scheme. Apply a theme to change the color scheme (mostly applies to sidebar and links).
To use a theme, add anyone of the available theme classes to the
<body> element in the
default.html layout, like so:
<body class="theme-base-08"> ... </body>
To create your own theme, look to the Themes section of included CSS file. Copy any existing theme (they're only a few lines of CSS), rename it, and change the provided colors.
BlackDoc's page orientation can be reversed with a single class.
<body class="layout-reverse"> ... </body>
Open sourced under the MIT license.