Code Monkey home page Code Monkey logo

Jekyll Garden v 0.3 (Stable)

This is a simple Jekyll theme created for building a digital garden with Obsidian and Github Pages. You have to fork this theme to your Github account, configure Github pages, and start using the _notes folder as the Obsidian vault. Check out the demo.

Installation (Github pages)

Detailed Installation how-to, with screenshots available here

Building a Jekyll website on Github Page is simple and seamless.

  • Step 1: Sign-In to Github, visit the theme page and click on 'Use this Template'
  • Step 2: Name the forked repo as yourusername.github.io
  • Step 3: Go to your repo's settings > pages and set the source to your main branch.
  • Step 4 (Optional): If you have a custom domain, set CNAME.

Claps! The Jekyll website with a Note Garden theme is ready. Visit yourusername.github.io to see that. If it's not working, edit this readme (add something and commit) to trigger static page generation.

Part 2, setting Github Repo with Obsidian.

  • Step 1: Go to yourusername.github.io, and clone your repository to your machine. For this, you can use git-commands or install Github for desktop.
  • Step 2: Once you have successfully cloned the repository to your machine, Open the Obsidian app, and set the folder _notes inside the repository as your vault.
  • Step 3: You can start adding notes to this vault and add frontmatter to support. Read about YAML at Welcome to the garden.
  • Step 4: Once you have enough notes, got to the Github Desktop app, commit the changes to main, and push the changes to Github. Github will update the pages!

Credits & Thanks

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.

License

The theme is available as open source under the terms of the MIT License.

ke3gen's Projects

jekyll-garden.github.io icon jekyll-garden.github.io

A Digital Garden Theme for Jekyll. Jekyll Garden lets you create a static HTML version of your markdown notes and publish via Github pages. Made for Obsidian users!

notenote.link icon notenote.link

A Jekyll digital garden template, optimized for integration with Obsidian. It aims to enhance discoverability and help you build a personal knowledge base that can scale with time.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.