docs: improve up and running to go through plugin config

This commit is contained in:
Ben Hong
2021-05-04 15:55:38 -04:00
parent 3b7816e548
commit 2b703c8bf2
4 changed files with 27 additions and 12 deletions

2
.obsidian/config vendored
View File

@@ -1 +1 @@
{"pluginEnabledStatus":{"file-explorer":true,"global-search":true,"switcher":true,"graph":true,"backlink":true,"command-palette":true,"markdown-importer":true,"word-count":true,"open-with-default-app":true,"tag-pane":true,"starred":true,"daily-notes":true,"zk-prefixer":true,"templates":true,"outline":true,"sync":false,"File explorer":true,"Search":true,"Quick switcher":true,"Graph view":true,"Backlinks":true,"Command palette":true,"Markdown format importer":true,"Word count":true,"workspaces":true,"random-note":true,"publish":true,"slides":true,"page-preview":true},"enabledPlugins":["calendar","cm-editor-syntax-highlight-obsidian","templater-obsidian","note-refactor-obsidian","sliding-panes-obsidian"],"showFrontmatter":true,"foldHeading":true,"foldIndent":true,"defaultViewMode":"source","showLineNumber":true,"cssTheme":"obsidian-night-owl-theme","promptDelete":false,"alwaysUpdateLinks":true,"fileSortOrder":"alphabetical","tabSize":4,"useTab":true,"theme":"obsidian","obsidianCss":false,"enabledCssSnippets":["dracula-custom-edits"],"attachmentFolderPath":"assets","spellcheck":true,"translucency":false,"hotkeys":{"insert-template":[],"app:go-back":[{"modifiers":["Alt","Mod"],"key":"ArrowLeft"}],"app:go-forward":[{"modifiers":["Alt","Mod"],"key":"ArrowRight"}],"daily-notes":[{"modifiers":["Mod"],"key":"T"}],"editor:toggle-italics":[{"modifiers":["Mod"],"key":"I"}],"app:toggle-left-sidebar":[{"modifiers":["Mod"],"key":"\\"}],"app:toggle-right-sidebar":[{"modifiers":["Mod","Shift"],"key":"\\"}],"editor:toggle-highlight":[{"modifiers":["Mod"],"key":"H"}],"editor:swap-line-down":[{"modifiers":["Alt"],"key":"ArrowDown"},{"modifiers":["Mod"],"key":"2"}],"editor:swap-line-up":[{"modifiers":["Alt"],"key":"ArrowUp"},{"modifiers":["Mod"],"key":"1"}],"graph:open-local":[{"modifiers":["Mod"],"key":"G"}],"backlink:open-backlinks":[],"editor:toggle-bold":[{"modifiers":["Mod"],"key":"B"}],"explorer:new-file":[{"modifiers":["Mod"],"key":"N"}],"zk-prefixer":[],"calendar:open-weekly-note":[{"modifiers":["Mod","Shift"],"key":"W"}],"workspace:close":[{"modifiers":["Mod"],"key":"W"}],"workspace:close-others":[{"modifiers":["Mod","Shift"],"key":"K"}],"graph:open":[{"modifiers":["Mod","Shift"],"key":"G"}],"workspace:split-horizontal":[{"modifiers":["Mod","Shift"],"key":"D"}],"workspace:split-vertical":[{"modifiers":["Mod"],"key":"D"}],"sliding-panes-obsidian:toggle-sliding-panes-rotated-headers":[{"modifiers":["Mod","Shift"],"key":"H"}],"note-refactor-obsidian:app:extract-selection-content-only":[],"note-refactor-obsidian:app:extract-selection-first-line":[{"modifiers":["Mod","Shift"],"key":"R"}],"daily-notes:goto-prev":[{"modifiers":["Mod"],"key":"Y"}],"explorer:new-file-in-new-pane":[{"modifiers":["Mod","Shift"],"key":"N"}],"editor:focus-top":[{"modifiers":["Alt","Mod"],"key":"ArrowUp"}],"editor:focus-bottom":[{"modifiers":["Alt","Mod"],"key":"ArrowDown"}],"editor:focus-left":[],"table-editor-obsidian:table-control-bar":[],"editor:delete-paragraph":[{"modifiers":["Mod"],"key":"Backspace"}],"sliding-panes-obsidian:toggle-sliding-panes-leaf-auto-width":[{"modifiers":["Mod","Shift"],"key":"A"}],"editor:toggle-fold":[{"modifiers":["Mod"],"key":"3"}],"templater-obsidian:insert-templater":[{"modifiers":["Mod","Shift"],"key":"I"}],"templater-obsidian:replace-in-file-templater":[]},"spellcheckDictionary":["netlify","dx","chickenless","zettelkasten","vue","instantiation","pre","congee","Mandalorian","Ideation","summarization","hypotheticals","integrations"],"newFileLocation":"folder","newFileFolderPath":"notes"} {"pluginEnabledStatus":{"file-explorer":true,"global-search":true,"switcher":true,"graph":true,"backlink":true,"command-palette":true,"markdown-importer":true,"word-count":true,"open-with-default-app":true,"tag-pane":true,"starred":true,"daily-notes":true,"zk-prefixer":true,"templates":true,"outline":true,"sync":false,"File explorer":true,"Search":true,"Quick switcher":true,"Graph view":true,"Backlinks":true,"Command palette":true,"Markdown format importer":true,"Word count":true,"workspaces":true,"random-note":true,"publish":true,"slides":true,"page-preview":true,"file-recovery":true},"enabledPlugins":["calendar","cm-editor-syntax-highlight-obsidian","note-refactor-obsidian","sliding-panes-obsidian","templater-obsidian"],"showFrontmatter":true,"foldHeading":true,"foldIndent":true,"defaultViewMode":"source","showLineNumber":true,"cssTheme":"obsidian-night-owl-theme","promptDelete":false,"alwaysUpdateLinks":true,"fileSortOrder":"alphabetical","tabSize":4,"useTab":true,"theme":"obsidian","obsidianCss":false,"enabledCssSnippets":["dracula-custom-edits"],"attachmentFolderPath":"assets","spellcheck":true,"translucency":false,"hotkeys":{"insert-template":[],"app:go-back":[{"modifiers":["Alt","Mod"],"key":"ArrowLeft"}],"app:go-forward":[{"modifiers":["Alt","Mod"],"key":"ArrowRight"}],"daily-notes":[{"modifiers":["Mod"],"key":"T"}],"editor:toggle-italics":[{"modifiers":["Mod"],"key":"I"}],"app:toggle-left-sidebar":[{"modifiers":["Mod"],"key":"\\"}],"app:toggle-right-sidebar":[{"modifiers":["Mod","Shift"],"key":"\\"}],"editor:toggle-highlight":[{"modifiers":["Mod"],"key":"H"}],"editor:swap-line-down":[{"modifiers":["Alt"],"key":"ArrowDown"},{"modifiers":["Mod"],"key":"2"}],"editor:swap-line-up":[{"modifiers":["Alt"],"key":"ArrowUp"},{"modifiers":["Mod"],"key":"1"}],"graph:open-local":[{"modifiers":["Mod"],"key":"G"}],"backlink:open-backlinks":[],"editor:toggle-bold":[{"modifiers":["Mod"],"key":"B"}],"explorer:new-file":[{"modifiers":["Mod"],"key":"N"}],"zk-prefixer":[],"calendar:open-weekly-note":[{"modifiers":["Mod","Shift"],"key":"W"}],"workspace:close":[{"modifiers":["Mod"],"key":"W"}],"workspace:close-others":[{"modifiers":["Mod","Shift"],"key":"K"}],"graph:open":[{"modifiers":["Mod","Shift"],"key":"G"}],"workspace:split-horizontal":[{"modifiers":["Mod","Shift"],"key":"D"}],"workspace:split-vertical":[{"modifiers":["Mod"],"key":"D"}],"sliding-panes-obsidian:toggle-sliding-panes-rotated-headers":[{"modifiers":["Mod","Shift"],"key":"H"}],"note-refactor-obsidian:app:extract-selection-content-only":[],"note-refactor-obsidian:app:extract-selection-first-line":[{"modifiers":["Mod","Shift"],"key":"R"}],"daily-notes:goto-prev":[{"modifiers":["Mod"],"key":"Y"}],"explorer:new-file-in-new-pane":[{"modifiers":["Mod","Shift"],"key":"N"}],"editor:focus-top":[{"modifiers":["Alt","Mod"],"key":"ArrowUp"}],"editor:focus-bottom":[{"modifiers":["Alt","Mod"],"key":"ArrowDown"}],"editor:focus-left":[],"table-editor-obsidian:table-control-bar":[],"editor:delete-paragraph":[{"modifiers":["Mod"],"key":"Backspace"}],"sliding-panes-obsidian:toggle-sliding-panes-leaf-auto-width":[{"modifiers":["Mod","Shift"],"key":"A"}],"editor:toggle-fold":[{"modifiers":["Mod"],"key":"3"}],"templater-obsidian:insert-templater":[{"modifiers":["Mod","Shift"],"key":"I"}],"templater-obsidian:replace-in-file-templater":[]},"spellcheckDictionary":["netlify","dx","chickenless","zettelkasten","vue","instantiation","pre","congee","Mandalorian","Ideation","summarization","hypotheticals","integrations"],"newFileLocation":"folder","newFileFolderPath":"notes"}

25
.obsidian/workspace vendored
View File

@@ -6,13 +6,9 @@
{ {
"id": "69f1e9b06a1b2a68", "id": "69f1e9b06a1b2a68",
"type": "leaf", "type": "leaf",
"active": true,
"state": { "state": {
"type": "markdown", "type": "empty",
"state": { "state": {}
"file": "templates/Pages/Page — Weekly Note — Template.md",
"mode": "source"
}
} }
} }
], ],
@@ -88,9 +84,7 @@
"type": "leaf", "type": "leaf",
"state": { "state": {
"type": "outline", "type": "outline",
"state": { "state": {}
"file": "templates/Pages/Page — Weekly Note — Template.md"
}
} }
}, },
{ {
@@ -104,6 +98,14 @@
{ {
"id": "1c6d265f778cffcf", "id": "1c6d265f778cffcf",
"type": "leaf", "type": "leaf",
"state": {
"type": "empty",
"state": {}
}
},
{
"id": "7bba91b6a631f56f",
"type": "leaf",
"state": { "state": {
"type": "calendar", "type": "calendar",
"state": {} "state": {}
@@ -122,7 +124,6 @@
"state": { "state": {
"type": "localgraph", "type": "localgraph",
"state": { "state": {
"file": "templates/Pages/Page — Weekly Note — Template.md",
"options": { "options": {
"collapse-filter": true, "collapse-filter": true,
"search": "-path:reports", "search": "-path:reports",
@@ -157,10 +158,11 @@
"state": { "state": {
"type": "backlink", "type": "backlink",
"state": { "state": {
"file": "templates/Pages/Page — Weekly Note — Template.md",
"collapseAll": false, "collapseAll": false,
"extraContext": false, "extraContext": false,
"sortOrder": "alphabetical", "sortOrder": "alphabetical",
"showSearch": false,
"searchQuery": "",
"backlinkCollapsed": false, "backlinkCollapsed": false,
"unlinkedCollapsed": true "unlinkedCollapsed": true
} }
@@ -174,6 +176,7 @@
"width": 514.754638671875, "width": 514.754638671875,
"collapsed": true "collapsed": true
}, },
"active": "69f1e9b06a1b2a68",
"lastOpenFiles": [ "lastOpenFiles": [
"templates/Pages/Page — Weekly Note — Template.md", "templates/Pages/Page — Weekly Note — Template.md",
"templates/Pages/Page — Project — Template.md", "templates/Pages/Page — Project — Template.md",

View File

@@ -12,3 +12,15 @@ An opinionated starter kit to help people get up and running as quickly as possi
4. Click on the `Open` button next to "Open folder as vault" 4. Click on the `Open` button next to "Open folder as vault"
5. Select the folder you've downloaded / cloned from Step #2. 5. Select the folder you've downloaded / cloned from Step #2.
6. When prompted with "Safe Mode," select `Turn off Safe Mode` which will enable you to utilize the third party plugins that are critical to this starter kit
7. You should be prompted with the "Preferences" pane, if not, you can open it by selecting the Settings (Cog) icon in the bottom left corner, or opening it with `Cmd + ,` (macOS) / `Ctrl + ,` (Windows)
<img src="/assets/preferences-panel.png" alt="Obsidian Preferences panel" width="300" />
8. Go to "Community Plugins"
9. Ensure all "Installed Plugins" by are enabled. If not, toggle the switch on each one to turn everything on
10. And you're good to go!
## Next Steps
This resource is currently in development and more documentation will be created as time goes on, but if you have specific questions, don't hesitate to file an issue on the repo!

Binary file not shown.

After

Width:  |  Height:  |  Size: 201 KiB