Jekyll Garden v 0.4!
Jekyll Garden theme lets you publish your Obsidian vault (or a subset of it) as a Jekyll static website. The theme is markdown and Obsidian setup friendly. You can use your own server or Github page to set up your SSG. Check out the demo.
Documents and links
Credits & Thanks
- See Credits page
Contribution
To set up your environment to develop this theme, run bundle install after cloning this repository in your local machine.
Your theme is set up just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. _notes contain all atomic notes. If you want to use this for blog, add posts inside _posts folder, following standard Jekyll frontamtter.
Hosting in a Docker Container
For hosting on your local network, inside a docker container, install docker and docker-compose and run,
$ docker-compose up -d
Note:-
This container is built upon on alpine based ruby image. There's an official Jekyll image available in docker hub which only support
amd64images. You can opt to use that if you are running the container on an 64bit PC. If you want to run this on an ARM based system like Raspberry Pi, this would be a better option.The directories which will be frequently modified, are mapped as local volumes so that any changes made to those will be immediately picked up by the server and built. If you fancy changing content in other folders regularly, feel free to add them to the
volumessection indocker-compose.ymlbefore deploying.
License
The theme is available as open source under the terms of the MIT License.
Project still not working
I'm trying again to deploy this template as a GH pages project (i.e. not usinggithub.io as the site root). The page itself is created but displays only as raw text without the theme.
I have several questions:
When I click on Use this template, should I check "Include all branches"?
In _config.yml, I am then setting the baseurl as and the url as <mroberts1.github.io>. Is that correct?
Do I need to create a gh-pages branch and add a .github/workflow/jekyll.yml file to it in order to get GH Pages to deploy it, or should it deploy as-is?
Alternatively, do I need to choose the Jekyll option from the GH Actions page to get the project to build properly?
Thanks for your help with this.
Added notes are displayed but link to note page throws 404.
When adding a note to the _notes/Public/ folder with a name "Animals.md", jekyll detects it and updates the feed for this collection. The element is then displayed in the feed, with preview and everything. So far so good.
When I click on the title link to /notes/Animals, the 404 page is thrown. Jekyll server also reports "ERROR `/notes/Animals' not found.
Any pointers?
Codeblocks are not showing Tabs or 4 Spaces properly
Hi, thanks for this awesome theme, it's really beautiful!
Unfortunately, I found some bugs.
As python are sensitive regarding indentation, this theme is not showing the indentation properly. For example, below is the markdown.
But when rendered, tabs are missing. I tried with both Tab and 4 spaces but they produced the same result no matter what.
Overall, it's a beautiful theme and I really like it. I hope you can help to fix this bug to improve how tabs inside code blocks are rendered.
Thank you!
GH Pages deploy not working
Can't get this to format properly when deployed on GH Pages, either using the template or forking the repo to my own account. I set the branch to main and saved in the Settings. Flushed the browser cache (Chrome) but issue persists.
When cloning the repo and installing Jekyll, it builds just fine locally, but when I then push it back up to GH it still won't format the repo on GH Pages.
The last template I tried is at github.com/mroberts1/supreme-couscous
Any idea what the problem might be?
Disable github action
After delete the repo (e.g luvata.github.io) that was created from this template, whenever I create a new repo with the same name, even if my repo have only one github workflows (defined in
.github/workflows/publish.yaml) there is always a github action namedpages-build-deploymentthat run this template. Sorry I'm quite new to github action, how can I disable this github action?Test project: https://github.com/Luvata/luvata.github.io/tree/master/.github/workflows
Burger navbar does not work
Hey! Thanks a lot for developing this template. I like it a lot, and I have used it for my own digital garden.
I am having problems with the navbar on mobile. Although it is visible, when clicking on it there is no menu or list of links that is shown. It is something that does not work on the demo website of the theme, or in your personal website.
I am new at making websites, so I cannot really help by providing a solution to this issue. Maybe you, or anyone that has forked this template, could give a hand?
Deploy outside of Github?
I really like this theme--thank you! Is it possible to deploy it outside of the Github ecosystem, e.g. if I have my own hosting somewhere else? How would I go about doing that?
Using simply Jekyll tags
Hi, I love this theme, thanks a lot for releasing it.
The only additional feature I would want is the tag feature of simply jekyll.
I’m very new to jekyll and was wondering : did you remove it on purpose ? was it causing other bugs ? I will try to do it on my own but it’s a bit hard to understand the full scope of the scripts for now.
-- Thanks again, it makes a really beautiful digital garden :)
(ps: sorry if it’s not the right place to this question, I’m not fully used to the contribution/community part of github)
Can't start jekyll server locally
I forked the project and github page looks fine. But when i run
bundle exec jekyll serve, I got an error like this:Dockerfile Please
Project maintainers, you can please add
Dockerfile, I'm not a ruby person, but I like jekyll tool. It is very hard for find gems and other dependencies. Can you please create Dockerfile for local devCould I port this theme to Hugo?
Thank you so much for such a fantastic, well-thought-out, and beautiful theme! I really love it.
And could I port this theme to Hugo? I'm not sure whether I could do it though……
Setting the homepage/enabled parameter to false in _config.yml does not work as expected.
Setting the homepage/enabled parameter to false should display the notes feed but it does not.
This is the current result
I will make a PR in order to fix that so the result will be is as follow
As we are on the homepage I removed the
← Homelinksupport for markdown highlights and inline mathjax
I use pkm for technical knowledge like statistics and i value displaying inline equation using mathjax. Same goes for highlighting using
==highlighted text==.Hope you can include this support. Thanks
cannot search by chinese；
thank you for your awesome work~~
here is my digital garden using the project。 https://blog.oldwinter.top/notes
there are some bug，could you please have a look？ 1，search can not support IME，when input method engine run ，search function cant work。 2，search can not support Chinese。
first bug like this：when I enter return，obsidian word go into search bar，but there is no result。
second bug like this：Chinese cant search any thing。
appreciate your time ，thanks~~~😃
Support for link aliasing
When writing a blog post, I want to be able to reference a link without using the actual name of the link.
I tried the below example and it doesn't seem to work:
[alias text]([[link]])OR[link|alias text]EDIT: doing this seems to work alias text, but i don't see the link when i hover over the link within the post