benjamn / garden

Home Page:https://benjamn.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Ben's Digital Garden

This MIT-licensed repository shares the generic Jekyll system behind the digital garden I publish at benjamn.dev.

Privacy of content

All my personal content is hidden away in a private submodule repository in the _notes/vault directory. After forking this repository, please be aware you will not automatically have access to my personal content, which remains under strict copyright (all rights reserved).

To work around this intentional limitation, you will need to either get rid of the submodule by running git rm _notes/vault, or run git submodule set-url ... to use a different private (or public) repository of your own:

git submodule set-url _notes/vault https://github.com/your-github-username/your-vault.git
git submodule update --init --recursive

Either way, my content stays with me.

Follow this link to create the personal access token you will need for checking out the private _notes/vault submodule when publishing your public garden.

Prior work/inspiration

Maxime Vaillancourt wrote a tutorial called Setting up your own digital garden with Jekyll that caught my eye, and this repository was originally a fork of Vaillancourt's Jekyll template, which you can find running on Netlify for comparison.

Original features (with some updates)

  • 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
    • Disabled for now for privacy of unlinked notes
  • Features a simple and responsive design
  • Supports Markdown or HTML notes

License

The source code, structure, and configuration of this repository are released under the MIT license, just like the LICENSE of the original template.

However, the content of the published benjamn.dev website and the content of the _notes/vault submodule remain under strict copyright, with all rights reserved by the GitHub user responsible for publishing them (that is, me).

About

https://benjamn.dev

License:Other


Languages

Language:SCSS 40.0%Language:HTML 33.5%Language:Ruby 13.8%Language:JavaScript 12.0%Language:Shell 0.8%