Skip to content

nhaouari/digital-garden-jekyll-template

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

List of changes

RTL support

You must use the ar layout for full RTL notes. It also supports mixed content.

Table Of Content

I used the following project for the table of content generation: jekyll-table-of-contents

Hash Tags page

  • Add a page that contains all the used hashtags (in YMAL) and the tagged pages.
  • Tags with url to the specific tag.
  • Inspired by: nickcharlton.net

Local Graph view

Links previews

  • Link previews work on all the internal links and the local graph view.
  • can scroll Link previews.

Easy deployment through GitHub in three steps

  • I used the following GitHub action:

Callouts & RTL Callouts

  • Small hack to use Callouts.
  • Available types: note, abstract, info, tip, success, question, warning, failure, danger, bug, example, quote.
  • The used CSS files from admonitions obsidian plugin. "

Netlify Status

Digital garden Jekyll template

Use this template repository to get started with your own digital garden.

I wrote a tutorial explaining how to set it up: Setting up your own digital garden with Jekyll

Preview the template here: https://digital-garden-jekyll-template.netlify.app/

  • Based on Jekyll, a static website generator
  • Supports Roam-style double bracket link syntax to other notes
  • Creates backlinks to other notes automatically
  • Features link previews on hover
  • Includes graph visualization of the notes and their links
  • Features a simple and responsive design
  • Supports Markdown or HTML notes

Screen Shot 2020-05-19 at 23 05 46

A note about GitHub Pages

GitHub Pages only partially supports this template: to power the interactive notes graph, this template uses a custom Jekyll plugin to generate the graph data in notes_graph.json, and GitHub Pages doesn't support custom Jekyll plugins.

If you want to use the graph with GitHub Pages, you may try building your garden locally using Jekyll then pushing the result to GitHub Pages.

Alternatively, you may deploy your garden to Netlify and it'll work out of the box. I wrote a guide explaining how to set this up.

If you don't care about the graph, you can simply remove it from this layout, as explained here.

License

Source code is available under the MIT license.

About

Start your own digital garden using this Jekyll template 🌱 + Obsidian

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Languages

  • JavaScript 96.8%
  • CSS 1.7%
  • Other 1.5%