dreat/digital_jungle
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

first seeds planted

Browse source
This commit is contained in:
Lukasz Skotarek 2023-01-29 13:16:41 +01:00
parent fa52922077
commit 965776fde3
22 changed files with 126 additions and 222 deletions
Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,32 +1,13 @@
[![Netlify Status](https://api.netlify.com/api/v1/badges/8cfa8785-8df8-4aad-ad35-8f1c790b8baf/deploy-status)](https://app.netlify.com/sites/digital-garden-jekyll-template/deploys)
# Entropic Jungle
# Digital garden Jekyll template
This marks second attempt at digital garden. This time I chose something with lower barrier to start writing.
Use this template repository to get started with your own digital garden.
As evertyhing in repo is work in progress and will grow overtime, so will this readme.
**I wrote a tutorial explaining how to set it up: [Setting up your own digital garden with Jekyll](https://maximevaillancourt.com/blog/setting-up-your-own-digital-garden-with-jekyll)**
Preview the template here: https://digital-garden-jekyll-template.netlify.app/
**Code forked from repo in this tutorial: [Setting up your own digital garden with Jekyll](https://maximevaillancourt.com/blog/setting-up-your-own-digital-garden-with-jekyll)**
- 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
<img width="1522" alt="Screen Shot 2020-05-19 at 23 05 46" src="https://user-images.githubusercontent.com/8457808/82400515-7d026d80-9a25-11ea-83f1-3b9cb8347e07.png">
## 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`](https://github.com/maximevaillancourt/digital-garden-jekyll-template/blob/7ac331a4113bac77c993856562acc2bfbde9f2f7/_plugins/bidirectional_links_generator.rb#L102), and [GitHub Pages doesn't support custom Jekyll plugins](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-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](https://maximevaillancourt.com/blog/setting-up-your-own-digital-garden-with-jekyll).
If you don't care about the graph, you can simply remove it from this layout, [as explained here](https://github.com/maximevaillancourt/digital-garden-jekyll-template/discussions/132#discussioncomment-3625772).
[link to GitHub template](https://github.com/maximevaillancourt/digital-garden-jekyll-template).
## License