From 9dca7e5756c264230d43eedb9eeeee6fddbe3c52 Mon Sep 17 00:00:00 2001 From: Noah <noah.wickel@rwth-aachen.de> Date: Mon, 6 Nov 2023 19:46:51 +0100 Subject: [PATCH] Changed 1 files. Affected files: README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 80ed199..1b2c437 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,19 @@ This is a template for a collection of text files (e.g. notebooks, wikis, "Zette - the plugin [Obsidian Link converter](https://github.com/ozntel/obsidian-link-converter) can be used to convert wikilinks to MdLinks - as a rule of thumb, avoid spaces in filenames if possible. If the file already has a space in it, the link must replace the space with `%20` like so: `[obsidian file](obsidian%20file.md)` +## Getting started +- (create your repository in GitLab (new project)) +- Clone this repository or the new one with `git clone` + - if on Windows, use https (not ssh) in order to conveniently push with the Obsidian Git plugin (see below) +- Open Obsidian and open the cloned folder as a new vault. If you already have a vault open, use the "Open another vault" button in the bottom left. +- Go to settings (`Ctrl+,`) and install the community plugins to ease your experience: + - Obsidian Git + - Obsidian Link Converter +- Set some hotkeys to Git pull, commit & push and for `Obsidian Link Converter: Vault: Links to Markdown` +- Create the gitignore file as below +- See more advice below ### .gitignore -The [.gitignore](.gitignore) file needs to contain the subfolder .obsidian in order not to push the personal settings for this vault. Obsidian cannot link to this file because it always assumes `.md` file endings, however in GitLab the link above should work. +The [.gitignore](.gitignore) file needs to contain the subfolder `.obsidian` in order not to push the personal settings for this vault. Obsidian cannot link to this file because it always assumes `.md` file endings, however in GitLab the link above should work. ## Test content - This is a test link to another [file](otherfile.md) -- GitLab