GithubHelp home page GithubHelp logo

License

All posts belong to me. You are not allowed to copy, puplish or modify them.

The Theme is under the same License as BlackDoc! Feel free to use it!

The design is based on BlackDoc

It was modified by myself to match the Numix color scheme.

BlackDoc

BlackDoc is a two-column Jekyll theme that's ideal for websites that require a master-detail layout for viewing of content. It's based on Poole, the Jekyll butler, and the Hyde theme.

BlackDoc screenshot

Contents

Features

  • Now compatible with Jekyll 3.x
  • Two-column layout with scrolling sidebar content
  • Ideal for websites that require master-detail view of content

Quick Start

Download the zip file or clone the BlackDoc repo.

$ git clone [email protected]: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

Usage

BlackDoc is a theme built on top of Poole, which provides a fully furnished Jekyll setup—just download and start the Jekyll server. See the Poole usage guidelines for how to install and use Jekyll.

Options

BlackDoc includes some customizable options, typically applied via classes on the <body> element.

Sidebar menu

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 page layout.

Scrolling sidebar content

By default, BlackDoc includes a scrolling sidebar that will display your markdown files in alphabetical order.

Themes

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.

Reverse layout

BlackDoc reverse screenshot

BlackDoc's page orientation can be reversed with a single class.

<body class="layout-reverse">
  ...
</body>

Author

Karlo Espiritu

License

Open sourced under the MIT license.

\m/

Thanks

Thanks to @mdo for creating the awesome Poole project.

Milian Reichardt's Projects

csbot icon csbot

An IRC bot written in C# with several games built in

curl icon curl

Curl is a tool and libcurl is a library for transferring data with URL syntax, supporting FTP, FTPS, HTTP, HTTPS, GOPHER, TFTP, SCP, SFTP, TELNET, DICT, LDAP, LDAPS, FILE, IMAP, SMTP, POP3, RTSP and RTMP. libcurl offers a myriad of powerful features

docker-pg_dump icon docker-pg_dump

Docker image with pg_dump running as a cron task. Updated docs and versions.

dynamic-coturn icon dynamic-coturn

Docker coturn server, with automatic restart for dynamic external IPs

filehelpers icon filehelpers

The FileHelpers are a free and easy to use .NET library to read/write data from fixed length or delimited records in files, strings or streams

hogwarts icon hogwarts

Hogwarts (Harry Potter) open sandbox game made in Unity

kinspector icon kinspector

KInspector is an application for analyzing health, performance and security of your Kentico solution.

openra icon openra

Open Source real-time strategy game engine for early Westwood games such as Command & Conquer: Red Alert written in C# using SDL and OpenGL. Runs on Windows, Linux, *BSD and Mac OS X.

tailblazer icon tailblazer

A modern file tail utility based on RX.Net which show cases reactive programming and Dynamic Data

thanos icon thanos

Highly available Prometheus setup with long term storage capabilities.

vim icon vim

The official Vim repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.