diff --git a/.obsidian/app.json b/.obsidian/app.json index 3a7557f..4595ee5 100644 --- a/.obsidian/app.json +++ b/.obsidian/app.json @@ -1,11 +1,7 @@ { - "legacyEditor": false, - "livePreview": true, "showFrontmatter": true, - "foldHeading": true, - "foldIndent": true, - "tabSize": 2, - "promptDelete": true, + "useTab": false, + "tabSize": 4, "alwaysUpdateLinks": true, "showUnsupportedFiles": true, "attachmentFolderPath": "_assets/attachments" diff --git a/.obsidian/appearance.json b/.obsidian/appearance.json index bdb2d68..32ce967 100644 --- a/.obsidian/appearance.json +++ b/.obsidian/appearance.json @@ -1,4 +1,5 @@ { + "accentColor": "#6e56cf", "baseFontSize": 15, "translucency": true } \ No newline at end of file diff --git a/.obsidian/command-palette.json b/.obsidian/command-palette.json deleted file mode 100644 index c37669c..0000000 --- a/.obsidian/command-palette.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "pinned": [ - "daily-notes" - ] -} \ No newline at end of file diff --git a/.obsidian/core-plugins-migration.json b/.obsidian/core-plugins-migration.json new file mode 100644 index 0000000..8cf7bcb --- /dev/null +++ b/.obsidian/core-plugins-migration.json @@ -0,0 +1,29 @@ +{ + "file-explorer": true, + "global-search": true, + "switcher": true, + "graph": true, + "backlink": true, + "canvas": true, + "outgoing-link": true, + "tag-pane": true, + "page-preview": false, + "daily-notes": true, + "templates": true, + "note-composer": true, + "command-palette": true, + "slash-command": true, + "editor-status": true, + "starred": true, + "markdown-importer": false, + "zk-prefixer": false, + "random-note": false, + "outline": true, + "word-count": true, + "slides": false, + "audio-recorder": false, + "workspaces": false, + "file-recovery": true, + "publish": false, + "sync": false +} \ No newline at end of file diff --git a/.obsidian/core-plugins.json b/.obsidian/core-plugins.json index 50a4c4f..e2e1f9c 100644 --- a/.obsidian/core-plugins.json +++ b/.obsidian/core-plugins.json @@ -4,9 +4,9 @@ "switcher", "graph", "backlink", + "canvas", "outgoing-link", "tag-pane", - "page-preview", "daily-notes", "templates", "note-composer", @@ -16,6 +16,5 @@ "starred", "outline", "word-count", - "audio-recorder", "file-recovery" ] \ No newline at end of file diff --git a/.obsidian/graph.json b/.obsidian/graph.json new file mode 100644 index 0000000..42a46ec --- /dev/null +++ b/.obsidian/graph.json @@ -0,0 +1,22 @@ +{ + "collapse-filter": true, + "search": "", + "showTags": false, + "showAttachments": false, + "hideUnresolved": false, + "showOrphans": true, + "collapse-color-groups": true, + "colorGroups": [], + "collapse-display": true, + "showArrow": false, + "textFadeMultiplier": 0, + "nodeSizeMultiplier": 1, + "lineSizeMultiplier": 1, + "collapse-forces": true, + "centerStrength": 0.518713248970312, + "repelStrength": 10, + "linkStrength": 1, + "linkDistance": 250, + "scale": 1, + "close": true +} \ No newline at end of file diff --git a/.obsidian/hotkeys.json b/.obsidian/hotkeys.json index bb711df..5dd7ae7 100644 --- a/.obsidian/hotkeys.json +++ b/.obsidian/hotkeys.json @@ -1,48 +1,39 @@ { - "command-palette:open": [ + "editor:insert-wikilink": [ { "modifiers": [ - "Mod", - "Shift" + "Mod" ], - "key": "P" + "key": "K" } ], - "app:delete-file": [ + "command-palette:open": [ { "modifiers": [ "Mod", "Shift" ], - "key": "Backspace" + "key": "P" } ], - "editor:delete-paragraph": [ + "app:delete-file": [ { "modifiers": [ - "Alt" + "Mod", + "Shift" ], "key": "Backspace" } ], - "workspace:edit-file-title": [ - { - "modifiers": [ - "Alt", - "Mod" - ], - "key": "T" - } - ], - "editor:focus": [ + "switcher:open": [ { "modifiers": [ "Mod" ], - "key": "1" + "key": "P" } ], - "workspace:split-horizontal": [ + "workspace:split-vertical": [ { "modifiers": [ "Mod" @@ -50,7 +41,7 @@ "key": "\\" } ], - "workspace:split-vertical": [ + "workspace:split-horizontal": [ { "modifiers": [ "Mod", @@ -62,8 +53,7 @@ "editor:swap-line-down": [ { "modifiers": [ - "Alt", - "Mod" + "Alt" ], "key": "ArrowDown" } @@ -71,20 +61,11 @@ "editor:swap-line-up": [ { "modifiers": [ - "Alt", - "Mod" + "Alt" ], "key": "ArrowUp" } ], - "editor:insert-wikilink": [ - { - "modifiers": [ - "Mod" - ], - "key": "K" - } - ], "editor:insert-link": [ { "modifiers": [ @@ -94,35 +75,31 @@ "key": "K" } ], - "switcher:open": [ + "open-with-default-app:open": [ { "modifiers": [ - "Mod" + "Ctrl" ], - "key": "P" + "key": "D" } ], - "open-with-default-app:open": [ + "open-with-default-app:show": [ { "modifiers": [ - "Alt", - "Mod" + "Ctrl" ], - "key": "D" + "key": "R" } ], - "open-with-default-app:show": [ + "app:toggle-left-sidebar": [ { "modifiers": [ - "Alt", "Mod" ], - "key": "R" + "key": "E" } ], - "editor:unfold-all": [], - "workspace:toggle-pin": [], - "app:toggle-left-sidebar": [ + "app:toggle-right-sidebar": [ { "modifiers": [ "Mod", @@ -131,13 +108,21 @@ "key": "E" } ], - "editor:toggle-fold": [], + "markdown:toggle-preview": [ + { + "modifiers": [ + "Ctrl" + ], + "key": "V" + } + ], "insert-template": [ { "modifiers": [ + "Alt", "Mod" ], - "key": ";" + "key": "I" } ] } \ No newline at end of file diff --git a/.obsidian/workspace b/.obsidian/workspace deleted file mode 100644 index 8306e8a..0000000 --- a/.obsidian/workspace +++ /dev/null @@ -1,135 +0,0 @@ -{ - "main": { - "id": "54d0e73770c5ea3a", - "type": "split", - "children": [ - { - "id": "d8878c909ec98bf7", - "type": "leaf", - "state": { - "type": "empty", - "state": {} - } - } - ], - "direction": "vertical" - }, - "left": { - "id": "e500e7fb3d937c4b", - "type": "split", - "children": [ - { - "id": "ef6417e6150798e2", - "type": "tabs", - "children": [ - { - "id": "150fbffedecb070c", - "type": "leaf", - "state": { - "type": "file-explorer", - "state": {} - } - }, - { - "id": "d08017cca22b7d22", - "type": "leaf", - "state": { - "type": "search", - "state": { - "query": "", - "matchingCase": false, - "explainSearch": false, - "collapseAll": false, - "extraContext": false, - "sortOrder": "alphabetical" - } - } - }, - { - "id": "0e405310a3fe3ead", - "type": "leaf", - "state": { - "type": "starred", - "state": {} - } - } - ] - } - ], - "direction": "horizontal", - "width": 300 - }, - "right": { - "id": "2c5ce0e13b3b3904", - "type": "split", - "children": [ - { - "id": "2b6d85425ed62ce4", - "type": "tabs", - "children": [ - { - "id": "236c023a3a3021e6", - "type": "leaf", - "state": { - "type": "backlink", - "state": { - "collapseAll": false, - "extraContext": false, - "sortOrder": "alphabetical", - "showSearch": false, - "searchQuery": "", - "backlinkCollapsed": false, - "unlinkedCollapsed": true - } - } - }, - { - "id": "4259f82f1ddb2b62", - "type": "leaf", - "state": { - "type": "outgoing-link", - "state": { - "linksCollapsed": false, - "unlinkedCollapsed": true - } - } - }, - { - "id": "01a9686786762397", - "type": "leaf", - "state": { - "type": "tag", - "state": { - "sortOrder": "frequency", - "useHierarchy": true - } - } - }, - { - "id": "1e1bd7b4a48f9c39", - "type": "leaf", - "state": { - "type": "outline", - "state": {} - } - } - ] - } - ], - "direction": "horizontal", - "width": 300, - "collapsed": true - }, - "active": "d8878c909ec98bf7", - "lastOpenFiles": [ - "daily/2022-07-07.md", - "LICENSE.md", - "CHANGELOG.md", - "_START HERE.md", - "README.md", - "_assets/templates/t_daily.md", - "daily/2022-04-09.md", - "daily/2022-01-13.md", - "START HERE.md" - ] -} \ No newline at end of file diff --git a/.obsidian/workspaces.json b/.obsidian/workspaces.json deleted file mode 100644 index 9e26dfe..0000000 --- a/.obsidian/workspaces.json +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file diff --git a/GETTING STARTED.md b/GETTING STARTED.md new file mode 100644 index 0000000..f955951 --- /dev/null +++ b/GETTING STARTED.md @@ -0,0 +1,53 @@ +> 👋 Welcome to your Obsidian vault + +## Cleanup Tasks + +The final step is to clean up some of the project specific files from GitHub. + +### Automagically + +Run the following command: + +```bash +rm -rf .github LICENSE README.md CHANGELOG.md version.txt +``` + +### Manual + +- [ ] Delete GitHub folder `rm -rf .github` +- [ ] Delete [[LICENSE]] +- [ ] Delete [[README]] +- [ ] Delete [[CHANGELOG]] +- [ ] Delete `version.txt` + +## Hotkeys + +> [!TODO] +> Go to `Settings->Hotkeys` to see all hotkeys and add your own. + +### Basics + +- New note: `⌘N` +- Open command palette: `⌘⇧P` +- Open quick switcher: `⌘P` +- Open settings: `⌘,` +- Delete a note: `⌘⇧Backspace` + +## Theme + +To install a new theme: + +1. Open Obsidian Settings +2. Go to `Appearance` and click `Manage` +3. Select a theme and click `Install and use` + +I personally use the [Minimal theme.](obsidian://show-theme?name=Minimal) + +## Obsidian Documentation + +I would suggest starting with these documentation pages: + +- [Creating Notes Documentation](https://help.obsidian.md/How+to/Create+notes) +- [Embedding Files Documentation](https://help.obsidian.md/How+to/Embed+files) +- [Block Level Linking Documentation](https://help.obsidian.md/How+to/Link+to+blocks) +- [YAML Front Matter Documentation](https://help.obsidian.md/Advanced+topics/YAML+front+matter) diff --git a/README.md b/README.md index 594623e..81e5217 100644 --- a/README.md +++ b/README.md @@ -1,100 +1,101 @@ -# Obsidian Beginner Vault Template +![2023-03-22T1722-Obsidian@2x](https://user-images.githubusercontent.com/18423853/227069885-83a9a90a-36a9-47c0-86fe-a7a124030f4b.png) -A minimal template for your first [Obsidian vault](https://obsidian.md) aimed at setting good defaults. +# Obsidian Beginner Vault Template -This template is intended for first time users of Obsidian. +A template for a minimal [Obsidian vault](https://obsidian.md/), 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 -- [Download and install Obsidian](https://obsidian.md/download) -- [Use this template](https://github.com/andrewmcodes/obsidian-beginner-vault-template/generate) and clone the repo -- Open Obsidian -- Click "Open" next to the "Open folder as vault" label -- Select the folder you cloned the repo to -- open `_START HERE.md` and follow the instructions +To use this template, follow these steps: + +1. Download and install Obsidian from [obsidian.md/download](https://obsidian.md/download). +2. Use this template by clicking the ["Use this template"](https://github.com/andrewmcodes/obsidian-beginner-vault-template/generate) 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 -- `_assets`: project specific files and folders - - `attachments`: this is where [attachment files](https://help.obsidian.md/How+to/Manage+attachments), like images, are stored - - `templates`: this is where [template files](https://help.obsidian.md/Plugins/Templates) are stored -- `daily`: [Daily Note](https://help.obsidian.md/Plugins/Daily+notes) storage +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 -These are the settings that have been modified from the defaults. +This section describes the settings that have been modified from the default Obsidian settings. ### Editor -| Setting | Value | -| ---------------- | ------- | -| Show frontmatter | Enabled | -| Fold heading | Enabled | -| Fold indent | Enabled | -| Use tabs | Enabled | -| Tab size | 2 | +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 | | ------------------------------------ | ----------------------------- | -| Confirm file deletion | Enabled (Asks first time) | -| Automatically update internal links | Enabled | -| Detect all file extensions | Enabled | +| 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 | | ------------------ | ------- | -| Translucent window | Enabled | +| Accent color | #6e56cf | | Font size | 15 | +| Translucent window | true | ### Hotkeys -I have modified some of the important hotkeys to better match VS Code's defaults since that is the text editor that I am most familiar with. Click the `Restore default` icon if you'd like to revert a specific hotkey to Obsidian's default hotkeys. +The following table lists the modified hotkeys: | Description | Shortcut | | ------------------------------------- | ----------- | | Add internal link | ⌘K | | Command palette: Open command palette | ⌘⇧P | | Delete current file | ⌘⇧Backspace | -| Delete paragraph | ⌥Backspace | -| Edit file title | ⌘⌥T | -| Focus on editor | ⌘1 | +| Templates: Insert Template | ⌘⌥I | | Quick switcher: Open quick switcher | ⌘P | -| Split horizontally | ⌘\ | -| Split vertically | ⌘⇧\ | -| Swap line down | ⇧⌥↓ | -| Swap line up | ⇧⌥↑ | +| Split right | ⌘\ | +| Split down | ⌘⇧\ | +| Move line down | ⌥↓ | +| Move line up | ⌥↑ | | Add Markdown link | ⌘⌥K | -| Open in default app | ⌘⌥D | -| Show in system explorer | ⌘⌥R | -| Toggle Left Sidebar | ⌘⇧E | -| | | - -### Core plugins - -| Plugin | Value | -| -------------------------------------------------------------------------------------- | -------- | -| [Outgoing Links](https://help.obsidian.md/Plugins/Outgoing+links) | Enabled | -| [Tag pane](https://help.obsidian.md/Plugins/Tag+pane) | Enabled | -| [Daily notes](https://help.obsidian.md/Plugins/Daily+notes) | Enabled | -| [Templates](https://help.obsidian.md/Plugins/Templates) | Enabled | -| Slash commands | Enabled | -| [Starred](https://help.obsidian.md/Plugins/Starred+notes) | Enabled | -| [Markdown format importer](https://help.obsidian.md/Plugins/Markdown+format+converter) | Disabled | -| [Outline](https://help.obsidian.md/Plugins/Outline) | Enabled | -| [Audio recorder](https://help.obsidian.md/Plugins/Audio+recorder) | Enabled | +| Open in default app | ⌃D | +| Reveal in Finder | ⌃R | +| Toggle Left Sidebar | ⌘E | +| Toggle Right Sidebar | ⌘⇧E | +| Toggle Reading View | ⌃V | -### Community Plugins +### Core Plugins + +The following core plugins are toggled by default in this template: -This vault does not come with any community plugins by default. +| Plugin | Value | +| ---------------- | ----- | +| Format converter | false | +| Page preview | false | +| Slash commands | true | -| Setting | Value | -| --------- | -------- | -| Safe mode | Disabled | +### 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 @@ -110,10 +111,6 @@ This vault does not come with any community plugins by default. | -------------------------- | --------------------------- | | New file location | daily | | Template file location | `_assets/templates/t_daily` | -| Open daily note on startup | Enabled | - -#### Hotkeys +| Open daily note on startup | true | -| Description | Shortcut | -| -------------------------- | -------- | -| Templates: Insert template | ⌘⌥I | +I hope this template helps you get started with Obsidian and provides a good base for customizing your own Obsidian vault. diff --git a/_START HERE.md b/_START HERE.md deleted file mode 100644 index 0f3b72b..0000000 --- a/_START HERE.md +++ /dev/null @@ -1,35 +0,0 @@ -# Welcome - -Welcome to your Obsidian vault. - -> [!IMPORTANT] Key Commands -> - New note: `⌘N` -> - Open command palette: `⌘⇧P` -> - Open quick switcher: `⌘P` -> - Open settings: `⌘,` -> - Open Wikilink: `⌘+Click` [[README]] to navigate to that note with the mouse -> - Delete a note: `⌘⇧Backspace` - -Go to `Settings->Hotkeys` to see all hotkeys and add your own. - -## Important Documentation - -I would suggest starting with these documentation pages: - -- [Creating Notes Documentation](https://help.obsidian.md/How+to/Create+notes) -- [Embedding Files Documentation](https://help.obsidian.md/How+to/Embed+files) -- [Block Level Linking Documentation](https://help.obsidian.md/How+to/Link+to+blocks) -- [YAML Front Matter Documentation](https://help.obsidian.md/Advanced+topics/YAML+front+matter) - -## Instructions - -The final step is to clean up some of the project specific files from GitHub: - -- [ ] _Optional_ Delete from git - - `rm -rf .git` -- [ ] Delete GitHub folder - - `rm -rf .github` -- [ ] Delete [[LICENSE]] -- [ ] Delete [[README]] -- [ ] Delete [[CHANGELOG]] -- [ ] Delete `version.txt` diff --git a/_assets/templates/t_daily.md b/_assets/templates/t_daily.md index c6da5f7..21bcf22 100644 --- a/_assets/templates/t_daily.md +++ b/_assets/templates/t_daily.md @@ -1,8 +1,11 @@ -# {{date}} - -## Notes +## Goals for Today +%%List your goals or tasks for the day.%% +## Accomplishments +%%Record your completed tasks and achievements.%% ---- +## Reflection +%% Before bed, reflect on the day, what went well, and what could have been improved.%% -#daily +## Notes +%%Jot down any thoughts, ideas, or observations throughout the day.%%