Skip to content

Latest commit

 

History

History
148 lines (99 loc) · 8.31 KB

README.md

File metadata and controls

148 lines (99 loc) · 8.31 KB
Raw

🏡 Obsidian Digital Garden

Publish your notes to the web, for free. In your own personal garden.

image

Docs

Documentation and examples can be found at dg-docs.ole.dev.

Digital-Garden-Demo

Features

  • Basic Markdown Syntax
  • Links to other notes
  • Dataview queries (as codeblocks, inline and dataviewjs)
  • Backlinks
  • Obsidian Themes
  • Style settings
  • Local graph
  • Filetree navigation
  • Global search
  • Callouts/Admonitions
  • Embedded/Transcluded Excalidraw drawings
  • Embedded/Transcluded Images
  • Transcluded notes
  • Code Blocks
  • MathJax
  • Highlighted text
  • Footnotes
  • Mermaid diagrams
  • PlantUML diagrams

Initial Setup

It's a bit of work to set this all up, but when you're done you'll have a digital garden in which you are in control of every part of it, and can customize it as you see fit. Which is what makes digital gardens so delightful. Lets get started:

  1. First off, you will need a GitHub account. If you don't have this, create one here.
  2. You'll also need a Vercel account. You can sign up using your GitHub account here
  3. Open this repo, and click the blue "Deploy to Vercel" button. This will open Vercel which in turn will create a copy of this repository in your GitHub accont. Give it a fitting name like 'my-digital-garden'. Follow the steps to publish your site to the internet.
  4. Now you need to create an access token so that the plugin can add new notes to the repo on your behalf. Detailed instructions with images are available in the docs. Use a Fine grained personal access token with the following settings: - Token Name: YYYY-Digital Garden - Expiration: Custom / a year / whatever you want. - Description: Publishing content to the digital garden. - Resource owner: yourself - Only select repositories: Select your garden repo - Permissions (just two needed): - Contents: Access: Read and write - Pull requests: Access: Read and write Click the "Generate token" button, and copy the token you are presented with on the next page.
  5. In Obsidian open the setting menu and find the settings for "Digital Garden". The top three settings here is required for the plugin to work. Fill in your GitHub username, the name of the repo with your notes which you created in step 3. Lastly paste the token you created in step 4. The other options are optional. You can leave them as is.
  6. Now, let's publish your first note! Create a new note in Obsidian. And add the following to the top of your file
---
dg-home: true
dg-publish: true
---

(If you get backticks, ```, at the start and beginning when copy-pasting the above text, delete those. It should start and end with a triple dash, ---. See this page for more info about Obsidian and frontmatter.)

This does two things:

  • The dg-home setting tells the plugin that this should be your home page or entry into your digital garden. (It only needs to be added to one note, not every note you'll publish).

  • The dg-publish setting tells the plugin that this note should be published to your digital garden. Notes without this setting will not be published. (In other terms: Every note you publish will need this setting.)

  1. Open your command palette by pressing CTRL+P on Windows/Linux (CMD+P on Mac) and find the "Digital Garden: Publish Single Note" command. Press enter.
  2. Go to your site's URL which you should find on Vercel. If nothing shows up yet, wait a minute and refresh. Your note should now appear.

Congratulations, you now have your own digital garden, hosted free of charge! You can now start adding links as you usually would in Obisidan, with double square brackets like this: [[Some Other Note]], to the note that you just published. You can also link to a specific header by using the syntax [[Some Other Note#A Header]]. Remember to also publish the notes your are linking to as this will not happen automatically. This is by design. You are always in control of what notes you actually want to publish. If you did not publish a linked note, the link will simply lead to a site telling the user that this note does not exist.

new-note-demo

Modifying the template/site

The code for the website is available in the repo you created in step 3, and this is yours to modify however you want. If you know some css I encourage you to change the default styling to make the site your own. Please modify the custom-style.scss when doing so to avoid future conflict when updating the template. Vercel should automatically update your site when you make changes to the code.

Updating the template

In the setting menu for the plugin there is, in addition to the previously mentioned settings, a setting with the name "Site Template" with a button saying "Manage site template". Clicking this should open up a popup-window with the setting "Update site to latest template" and a button saying "Create PR". Whenever digital garden template receives any updates, this button can be used to update your site. It will create a new branch in your repo with the changes and create a Pull Request to your main branch. The plugin will present you with this URL in the setting view.

If you used the "Deploy to Vercel" button, a Vercel bot will build a preview version of your site which you can visit to see that the changes does not contain any breaking changes. The URL should be visible in the PR. When you are ready you can use the "Merge pull request" button on the pull request page to merge the changes into your main branch and make the changes go live.

In the future you will be notified with a visual cue whenever there is an update ready. For now you will need to manually check. If you have the latest version, you will be told so.

Advanced changes for developers

The project uses the eleventy templating engine. This uses .eleventy.js as the main entry-point. Please read the eleventy docs if you need a quick-start on how this works.

If you want to do any changes that aren't overwritten when updating the template, do so in the src/helpers/userSetup.js file, which hooks into the elventy setup in .eleventy.js

Local development

NOTE: this plugin contains a testing vault at src/dg-testVault, which is recommended for local development.

  1. Clone this repository

  2. (for best compatability, use node version manager and run nvm install && nvm use)

  3. Install dependencies with npm install

  4. Run with npm run dev

  5. Open the vault from src/dg-testVault into obsidian

  6. (if you want to develop this plugin with another vault, move it into .obsidian/plugins of that vault)

To use the test vault with github, add your test repository values to a .env file with:

GITHUB_REPO=
GITHUB_TOKEN=
GITHUB_USERNAME=

Note: this repository uses prettier and eslint to enforce code formatting and style. It is recommended to install these to your IDE for automatic formatting and error highlighting.

Join the Community

Be a part of the Digital Garden Community by joining our Discord Server.

Code Contributers

Huge thanks to all the contributors who helped in making this

Support

This plugin is developed in my free time. If you've found it useful, it would make my day and boost my motivation to invest more time in it if you to showed your support by buying me a coffee.

Note that you in no way have to feel any pressure to do this. The plugin is completely free, and will remain free in the unforeseeable future.