https://github.com/col-e/jekyll-obsidian-theme

A dark Jekyll theme
https://github.com/col-e/jekyll-obsidian-theme

jekyll jekyll-theme jekyll-themes

Last synced: about 2 months ago
JSON representation

A dark Jekyll theme

• Host: GitHub
• URL: https://github.com/col-e/jekyll-obsidian-theme
• Owner: Col-E
• License: mit
• Created: 2020-12-21T05:34:38.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-17T22:21:40.000Z (almost 4 years ago)
• Last Synced: 2024-10-11T19:40:47.289Z (3 months ago)
• Topics: jekyll, jekyll-theme, jekyll-themes
• Language: CSS
• Homepage:
• Size: 431 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Obsidian

A simplistic dark theme for Jekyll. Comes with code syntax highlighting.

![An example that is fully configured](example.png)

## Installation

Add this line to your Jekyll site's `Gemfile`:

```ruby

gem "obsidian-theme"

```

And add this line to your Jekyll site's `_config.yml`:

```yaml

theme: obsidian-theme

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install obsidian

## Usage

**Layouts**

At the moment only `default` exists.

**Assets**

Pluginable asset paths include:

- `assets/img/logo.png`

- `assets/img/favicon.png`

**Data**

To configure the side bar table-of-contents create a file `_data/sitemap.yml` and follow the given YAML pattern:

```yaml

toc:

  - title: MyTitleName

    subfolderitems:

      - page: Example Page 1

        url: /example1.html

```