# Obsidian Technical Documentation

## Table of Contents

- [Introduction](#introduction)
- [Core Features](#core-features)
- [User Guide](#user-guide)
  - [Installation & Setup](#installation--setup)
  - [Creating & Managing Notes](#creating--managing-notes)
  - [Extending with Plugins](#extending-with-plugins)
  - [Synchronization & Backup](#synchronization--backup)
- [Advanced Features](#advanced-features)
  - [Markdown Support](#markdown-support)
  - [Links & References](#links--references)
  - [Templates & Snippets](#templates--snippets)
- [Troubleshooting](#troubleshooting)
- [Resources & Support](#resources--support)

---

## Introduction

Obsidian is an open-source note-taking and knowledge management application designed for users who are passionate about organizing and managing vast amounts of information. Its unique features and flexible plugin ecosystem make it an ideal choice for knowledge workers and students alike.

## Core Features

### Powerful Markdown Editor
- **Rich Syntax**: Supports a rich set of Markdown syntax to help users create structured and beautifully formatted notes.
- **Customization**: Users can customize the editor's appearance using themes and CSS snippets.
- **Live Preview**: Instantly see how your notes will look as you type, without leaving the editor.

### Bidirectional Links
- **Easy Connections**: Establish connections between notes using built-in linking capabilities, enabling information association and indexing.
- **Backlinks Panel**: View all links pointing to a specific note, facilitating discovery and navigation within your knowledge base.

### Plugin Ecosystem
- **Vast Library**: Obsidian boasts a vast library of plugins that allow users to add additional functionality as needed, such as calendars, charts, themes, and more.
- **Community Contributions**: The active community continuously contributes new plugins and updates existing ones.

### Offline Storage
- **Local Data**: All notes are saved locally on the device, ensuring data security and privacy without relying on an internet connection.
- **Portability**: Take your Vault with you by syncing it across devices using cloud storage services.

## User Guide

### Installation & Setup

#### Download Obsidian
1. Visit the [Obsidian official website](https://obsidian.md/).
2. Choose the appropriate version for your operating system (Windows, macOS, Linux).
3. Click the download button to start the installation process.

#### Install the Program
1. Run the downloaded installer.
2. Follow the on-screen instructions to complete the installation.

#### Create a Vault
1. Launch Obsidian after installation.
2. You will be prompted to create a new Vault or open an existing one.
3. Choose a location on your computer where you want to store your notes.
4. Name your Vault and click "Create."

### Creating & Managing Notes

#### New Note
1. Click the "+" button in the left sidebar or use the shortcut `Ctrl+N` (Windows/Linux) or `Cmd+N` (macOS) to create a new note.
2. Name your note and start writing content.

#### Edit Note
- Use Markdown syntax to format your note:
  - **Headers**: `# H1`, `## H2`, `### H3`
  - **Bold**: `**bold text**`
  - **Italic**: `*italic text*`
  - **Lists**: `- Item 1`, `1. Ordered item`
  - **Images**: `![alt text](image-url)`
  - **Code Blocks**: ```\`\`\`code\nyour code here\n\`\`\` ```
  - **Tables**: 
    ```markdown
    | Column 1 | Column 2 |
    | --- | --- |
    | Row 1, Cell 1 | Row 1, Cell 2 |
    | Row 2, Cell 1 | Row 2, Cell 2 |
    ```

#### Organize Notes
- **Folders**: Create folders to categorize your notes.
- **Tags**: Use tags (`#tag`) to label notes for easy search and filtering.
- **Links**: Connect related notes using internal links (`[[Note Name]]`).

### Extending with Plugins

#### Open Plugin Settings
1. Go to the "Settings" menu.
2. Click on "Plugins" in the left sidebar.

#### Browse & Install Plugins
1. In the "Community Plugins" tab, browse available plugins.
2. Click "Install" next to the plugins you need.
3. Restart Obsidian if prompted.

#### Configure Plugins
1. After installation, go back to the "Plugins" settings.
2. Configure each plugin as needed to achieve the desired functionality.

### Synchronization & Backup

#### Local Backup
1. Regularly copy your Vault to an external storage device or cloud storage service.
2. Ensure backups are up-to-date to prevent data loss.

#### Use Third-Party Sync Tools
1. Utilize cloud storage services like Dropbox, Google Drive, or OneDrive to synchronize your Vault across multiple devices.
2. Set up automatic sync to keep your notes updated in real-time.

## Advanced Features

### Markdown Support

Obsidian fully supports Markdown syntax, including headers, lists, code blocks, images, tables, and more. By using these syntax elements wisely, you can create structured and beautifully formatted notes.

### Links & References

Obsidian's bidirectional linking feature allows you to create connections between notes. Simply use the special link format `[[Note Name]]` to create a link. This linking method not only facilitates searching and referencing but also establishes a complex web-like structure between notes.

### Templates & Snippets

By creating templates and snippets, you can quickly insert commonly used text or structures, improving note editing efficiency. Templates and snippets can be stored in your Vault and accessed at any time.

## Troubleshooting

- **Software Crash**: Try closing and reopening Obsidian or restarting your computer.
- **Plugin Conflict**: If issues arise after installing a new plugin, try disabling it to determine if it is the cause of the problem.
- **Data Loss**: Regularly check your Vault backups to prevent data loss.

## Resources & Support

- **Official Website**: [Obsidian Official Website](https://obsidian.md/)
- **User Forum**: Join the [Obsidian user forum](https://forum.obsidian.md/) to exchange ideas and experiences with other users.
- **Plugin Marketplace**: Browse and install various plugins from the [official plugin marketplace](https://obsidian.md/plugins) to extend Obsidian's functionality.

---