Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robert-zacchigna/blackdocplus
A modernized version of the BlackDoc theme: a two-column Jekyll theme for websites that require a master-detail layout for viewing of content. You can view my personal site here (it might look a little different): https://robert-zacchigna.github.io/
https://github.com/robert-zacchigna/blackdocplus
jekyll jekyll-blog jekyll-site jekyll-template jekyll-theme jekyll-themes static-site-generator
Last synced: 3 months ago
JSON representation
A modernized version of the BlackDoc theme: a two-column Jekyll theme for websites that require a master-detail layout for viewing of content. You can view my personal site here (it might look a little different): https://robert-zacchigna.github.io/
- Host: GitHub
- URL: https://github.com/robert-zacchigna/blackdocplus
- Owner: Robert-Zacchigna
- License: mit
- Created: 2021-11-29T19:08:46.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-02T01:28:43.000Z (5 months ago)
- Last Synced: 2024-09-29T03:00:45.981Z (3 months ago)
- Topics: jekyll, jekyll-blog, jekyll-site, jekyll-template, jekyll-theme, jekyll-themes, static-site-generator
- Language: HTML
- Homepage: https://robert-zacchigna.github.io/BlackDocPlus/
- Size: 4.17 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# BlackDocPlus (GitHub Page)
* View Demo: [BlackDocPlus](https://robert-zacchigna.github.io/BlackDocPlus/)
* View the Original Theme: [BlackDoc](https://robert-zacchigna.github.io/BlackDoc)
To run this site locally, use the [local](https://github.com/Robert-Zacchigna/BlackDocPlus/tree/local) branch
BlackDoc is a two-column [Jekyll](http://jekyllrb.com) theme that's ideal for websites that require a master-detail
layout for viewing of content. It's based on [Poole](http://getpoole.com), the Jekyll butler, and the [Hyde](http://hyde.getpoole.com) theme.
## Contents
- [Features](#features)
- [Quick Start](#quick-start)
- [Usage](#usage)
- [Options](#options)
- [Sidebar menu](#sidebar-menu)
- [Scrolling sidebar content](#scrolling-sidebar-content)
- [Themes](#themes)
- [Development](#development)
- [Author](#author)
- [License](#license)
## 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.
```bash
$ git clone [email protected]:karloespiritu/BlackDoc.git mysite
$ cd mysite
```
Make sure you have Ruby 3.1.2 or higher installed.
```bash
$ ruby --version
ruby 3.2.1
```
Install bundler and install dependencies.
```bash
$ gem install bundler
$ gem install jekyll bundler
$ bundle install
$ bundle update --bundler
```
Build and run your BlackDoc site.
```bash
$ bundle exec jekyll serve
```
>**NOTE:** Use the [local](https://github.com/Robert-Zacchigna/BlackDocPlus/tree/local) branch if you want to build this
> site locally, this version is only for running the site through GitHub Pages.
## Usage
BlackDoc is a theme built on top of [Poole](https://github.com/poole/poole), which provides a fully furnished Jekyll
setup—just download and start the Jekyll server. See [the Poole usage guidelines](https://github.com/poole/poole#usage)
for how to install and use Jekyll.
## Options
BlackDoc includes some customizable options, typically applied via classes on the `` 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](http://jekyllrb.com/docs/frontmatter/).
```
---
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](https://github.com/chriskempson/base16).
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 `` element in the `default.html` layout, like so:
```html
...
```
To create your own theme, look to the Themes' section of [included CSS file](https://github.com/Robert-Zacchigna/blackdocplus/blob/master/public/css/blackdoc.css).
Copy any existing theme (they're only a few lines of CSS), rename it, and change the provided colors.
## Original Theme Author
**Karlo Espiritu**
-
-
## Theme Modification By
**Robert Zacchigna**
-
## License
Open sourced under the [MIT license](LICENSE.md).