Getting Started with Obsidian

This repository is set up to act as a dual-purpose system: a Git-controlled website repository and a local Obsidian vault.

Follow these steps to write, edit, and publish notes seamlessly.

---

1. Open the Vault in Obsidian

1. Launch Obsidian on your computer.
2. In the startup screen, select “Open folder as vault”.
3. Browse and select your local clone of this repository: ~/Documents/GitHub/paco.io/
4. Obsidian will load the folder. You will see this page, index.md, and the folder hierarchy in the Obsidian sidebar!

---

2. Configure Obsidian Settings (Important)

To ensure links between pages compile correctly on the static website, adjust this setting:

1. Open Obsidian Settings (click the gear icon in the bottom-left).
2. Go to Files and Links.
3. Locate Use Markdown links and toggle it ON.
   • This forces Obsidian to write standard [Page](page.md) links instead of wikilinks [[page]].
   • The website’s rendering engine will automatically convert .md extensions to .html when compiling.

---

3. Install the Obsidian Git Plugin

To push your updates from Obsidian directly without using the command line:

1. In Obsidian Settings, go to Community plugins and click Enable community plugins.
2. Click Browse and search for Git (by Vinzent03).
3. Install and enable the plugin.
4. Go to the plugin settings to set up auto-backup intervals (e.g., commit and push every 15 minutes) or assign a hotkey to manually push updates.

---

[!WARNING] Syncing Settings If you do not want to push your local Obsidian window positions, search history, and plugin configurations to the public website, make sure to add .obsidian/ to your .gitignore file.

If you already have a .gitignore, it should contain:

.obsidian/workspace.json
.obsidian/cache/
.trash/

---

4. Create and Publish Notes

Any .md file you create in the root folder or subfolders will be parsed by Jekyll.

To ensure it renders with the correct site layout, include this brief header at the very top of each new note:

---
layout: default
title: My New Note Title
---

When you save the note and push it to GitHub, the site will automatically rebuild and your new page will appear in the Vault Explorer sidebar tree!