Git Product home page Git Product logo

obsidian-template's Introduction

2023-03-22T1722-Obsidian@2x

Obsidian Beginner Vault Template

A template for a minimal Obsidian vault, focused on setting good defaults and VS Code-like hotkeys. If you want to try Obsidian for the first time or just get a barebones template, you're in the right place.

Getting Started

To use this template, follow these steps:

  1. Download and install Obsidian from obsidian.md/download.
  2. Use this template by clicking the "Use this template" button on this page and cloning the repo.
  3. Open Obsidian.
  4. Click "Open" next to the "Open folder as vault" label.
  5. Select the folder you cloned the repo to.
  6. Open GETTING STARTED.md and follow the instructions.

Folder Structure

The template vault has the following folder structure:

  • _assets: this folder contains project-specific files and folders.
    • attachments: this is where attachment files like images are stored.
    • templates: this is where template files are stored.
  • daily: this folder is used for storing daily notes.

Settings

This section describes the settings that have been modified from the default Obsidian settings.

Editor

The following table lists the editor settings that have been modified:

Setting Value
Show frontmatter true
Use tabs false

Files & Links

Warning If you are following along instead of using the template, make sure you have created the default folders listed above.

The following table lists the files and links settings that have been modified:

Setting Value
Automatically update internal links true
Detect all file extensions true
Default location for new attachments In the folder specified below
Attachment folder path _assets/attachments

Appearance

The following table lists the appearance settings that have been modified:

Setting Value
Accent color #6e56cf
Font size 15
Translucent window true

Hotkeys

The following table lists the modified hotkeys:

Description Shortcut
Add internal link ⌘K
Command palette: Open command palette ⌘⇧P
Delete current file ⌘⇧Backspace
Templates: Insert Template ⌘⌥I
Quick switcher: Open quick switcher ⌘P
Split right ⌘\
Split down ⌘⇧\
Move line down ⌥↓
Move line up ⌥↑
Add Markdown link ⌘⌥K
Open in default app ⌃D
Reveal in Finder ⌃R
Toggle Left Sidebar ⌘E
Toggle Right Sidebar ⌘⇧E
Toggle Reading View ⌃V

Core Plugins

The following core plugins are toggled by default in this template:

Plugin Value
Format converter false
Page preview false
Slash commands true
Bookmarks true
Properties true

Community Plugins

This vault does not come with any community plugins by default. You will have to disable safe mode in order to use them when you open the plugins settings menu.

Core Plugin Options

Setting Value
Template folder location _assets/templates
Setting Value
New file location daily
Template file location _assets/templates/t_daily
Open daily note on startup true

I hope this template helps you get started with Obsidian and provides a good base for customizing your own Obsidian vault.

obsidian-template's People

Contributors

josephjoberno avatar

Watchers

 avatar

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.