Skip to content

lawrencet149/notebook_demo

 
 

Repository files navigation

README

image This repository contains a template Obsidian vault for academic note-taking. It contains demo workflows, demo files and has some useful community plugins installed and configured.

Purpose of the vault

The purpose of this vault is to help you get started with Obsidian and some of the (in our view) useful plugins and workflows for academic notetaking. You can use this vault as a starting point to customize you own academic vault. The vault is set up to

  • Organize tasks in your projects
  • Organize your days and weeks with automatic note templates that collect all the tasks and meetings happening today
  • Set up meetings and create meeting notes
  • Connect your Zotero database, and generate literature notes
  • Manage your knowledge using a Zettelkasten system
  • ... The vault contains readme files within the Folder "00_GetStarted" that help you learn about Obsidian and the vault and that point you to further resources about Obsidian and customization.

Get started

To get started with the vault you can follow the instructions below or you can follow this tutorial on Youtube:

  1. Download and install Obsidian for your machine from here
  2. Download this notebook_demo (Click on the green "Code" button on the top right and download as ZIP)
  3. Unzip the notebook_demo and save it at a convenient location on your machine. If you want backup and/or synchronization, this location can e.g. be a Cloud storage location.
  4. Rename the folder that contains the notebook_demo if you want
  5. Start Obsidian, click "Open folder as vault" and select the folder containing the downloaded notebook. Obsidian will then open the notebook as a vault.
  6. While opening, a warning will pop up asking for permission to enable plugins that the vault contains. These plugins are necessary for the full functionality of the vault. Here, you can read more about the plugin security policy of Obsidian: here
  7. On the left of the Obsidian editor in the folder "00_GetStarted", you find notes that help you to get started with Obsidian and your vault. Read these before you start working with the vault:
    1. [[Get Started - Obsidian]] to find out more about Obsidian in general and how to use it.
    2. [[Get Started - Vault]] to find out which settings and plugins were used in the demo vault and how to use them properly. Here we link to files describing workflows that we pre-configured in the demo vault ([[Create note from template]], [[Project management]], [[Knowledge management with Zettelkasten]], [[Literature notes from Zotero]], [[Periodic notes and lab journal]])
    3. [[Get Started - Resources]] lists more resources and tips for additional customization. You can have a look at this when you are a bit more familiar with the vault and Obsidian.

If you have any questions or comments, please create an issue on Github. Please also feel free to contribute to the project via pull requests.

About

An Obsidian Notebook demo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published