Obsidian Help Documentation

This repository contains the source files for the Obsidian Help documentation and all supported language translations. Each language is maintained as a stand-alone Obsidian vault and published via Obsidian Publish.

Note: This repository is for documentation content only. Do not open issues here for Obsidian software bug reports or feature requests; those should be directed to the Obsidian forum.

Obsidian Publish is a cloud-based hosting service designed to transform your Obsidian notes into a public-facing wiki, knowledge base, documentation site, or digital garden.

To publish content, you select the specific notes you wish to share and use the Publish command within Obsidian. Your content is then hosted at publish.obsidian.md/your-site.

Obsidian stores notes as local files in a folder called a vault. Because data is local, you must set up a sync method to access the same vault across multiple devices. Common methods include:

1. First-party sync: Obsidian Sync (officially supported).
2. Third-party cloud sync: iCloud, OneDrive, and Google Drive.
3. Local sync: Syncthing (decentralized, no cloud required).
4. Version control: Git and Working Copy.

You can also find alternative options in the Community plugins directory.

Obsidian Headless provides command line access to the following services:

• Headless Sync: Use Obsidian Sync from the command line to sync vaults without the desktop app.
• Headless Publish: Use Obsidian Publish from the command line without the desktop app.

Obsidian Publish provides several capabilities for managing and optimizing your hosted site:

• Site Management: Manage multiple Publish sites.
• Collaboration: Share a Publish site with collaborators.
• Customization: Customize the appearance and behavior of your site.
• Custom Domains: Use your own domain instead of the default publish.obsidian.md subdomain.
• Permalinks: Define permanent URLs for specific pages.
• Analytics: Set up tracking to monitor site traffic.
• SEO: Implement search engine optimization for your published content.
• Security and Privacy: Manage data safety and privacy settings.

The Live Preview mode includes several rendering and formatting capabilities:

• Backlinks: Backlinks within a document are available in Live Preview and can be toggled via the pane menu.
• Block Rendering: Mermaid diagrams, query blocks, and certain custom code blocks from plugins are rendered.
• Auto-pairing: Markdown formatting symbols like $, =, ~, and % support auto-pairing of brackets.
• Formatting Improvements: Enhanced handling for block quotes, image sizing, and markdown link styling.

You can publish Obsidian-based wikis, knowledge bases, or documentation using several methods:

1. Obsidian Publish: The official service for creating public and private sites directly from the Obsidian app.
2. Static Site Generators (SSGs): Obsidian is compatible with most SSGs, including Jekyll, Hugo, Astro, and Quartz.
3. Third-party services: Use community plugins to publish to platforms like Confluence or Jira.

Obsidian Sync requires a subscription plan. There are two main tiers: Sync Standard and Sync Plus.

Note that storage limits are account-wide and include notes, attachments, and version history. You can purchase additional storage up to 100 GB on the Sync Plus plan via your account dashboard.

Obsidian is a Markdown editor and a knowledge base application designed for managing networked information. Its core philosophy is built on three pillars:

1. Data Ownership: Your data is stored as plain text files on your local hard disk. This allows you to use any file system utility for backups (e.g., Dropbox), version control (e.g., Git), or security (e.g., disk encryption).
2. Networked Thought: Instead of relying solely on hierarchy, Obsidian treats links as first-class citizens. You can create connections between ideas using [[Internal links]] and visualize these relationships through the [[Graph view]].
3. Extensible Toolkit: Rather than a monolithic, opinionated product, Obsidian provides a foundation (viewing, editing, and searching files) and allows you to build a custom workflow using modular building blocks.

The Obsidian Web Clipper provides several tools for interacting with web content:

• Clipping: Save content from web pages to your vault.
• Highlighter: Select specific elements or passages to save.
• Reader: View web pages in a clean, distraction-free mode.
• Interpreter: Use natural language prompts to capture and modify data on a page.
• Templates: Create custom templates for specific websites.
• Variables & Filters: Pre-populate template data and modify output using variables and filters.
• Logic: Implement conditionals, loops, and variable setting within templates.