Obsidian для чайников

Данная статья – дубликация уже мною выложенной на гитхабе ^[1], но на Хабре

Что такое Obsidian и Markdown?

Obsidian — это не облачный сервис, а удобный и красивый интерфейс для работы с локальными текстовыми файлами формата .md

Основные плюсы:

1. Все файлы хранятся у вас. Они не пропадут, и вас не смогут забанить. Но главное — никакой сети для написания заметок вам не нужно.

2. Они лёгкие по весу, так как любые фишки работают при помощи текстовых символов. В отличие от Word, например, где передаются ненужные данные о размерах шрифта, самом шрифте, расположении каждого абзаца на странице и пр. Подробнее рассказано в этом видео на YouTube ^[2].

3. Очень легко налаживать контроль версий, особенно с таким средством, как GitHub: легко отследить, какая строка изменилась, какой файл был перемещён и т.п.

4. Есть множество уникальных фишек: возможность ссылаться на другие заметки, бесчисленное множество плагинов, самые разнообразные темы и многое другое.

Но не стоит забывать ^[3], что всё это лишь для удобства ведения заметок, не более того. Не нужны заметки? Не нужно хранить информацию? Тогда закройте эту вкладку.

Как пользоваться? Где изучить Markdown и возможности приложения?

Скачать Obsidian можно с официального сайта: Download – Obsidian ^[4]

Когда вы решитесь освоить Obsidian, советую пройти гайд от самих разработчиков. Цель гайда — научить вас работать в Markdown и показать некоторые уникальные фишки Obsidian. Если вас интересует что-то другое касательно Obsidian, то у вас всегда есть возможность посетить официальный сайт — Home – Obsidian Help ^[5] или просто Obsidian – Sharpen your thinking ^[6].

Для получения полного гайда вам потребуется либо в меню Manage Vaults найти Sandbox Vault, либо, если его там нет, открыть любую папку как Vault, а затем снизу в панели настроек найти знак вопроса, кликнув по которому, вы откроете меню с пунктом Sandbox Vault.

Как оказалось, эти инструкции — не полный и, признаться честно, не лучший разбор возможностей Obsidian: уж больно простым языком всё рассказывается. Совершенно случайно мне попался разбор куда лучше, так сказать, уже для взрослых, но предназначенный изначально для обучения ^[7] Gemini работе с приложением. Этот разбор я скачал с сайта плагина Gemini Scribe ^[8]. В папке bundled-skills ^[9] есть несколько заметок, но для человека полезна только эта четвёрка:

• Obsidian Flavored Markdown ^[10] — базовый синтаксис, ссылки и эмбеды.

• Obsidian Properties ^[11] — работа со свойствами заметок (frontmatter).

• JSON Canvas ^[12] — бесконечный холст Obsidian.

• Obsidian Bases ^[13] — базы данных внутри приложения.

Для изучения Obsidian достаточно прочитать 1-ый файл, obsidian-markdown ^[10], в котором рассказывается самый, что называется, сок. Остальное — уже на любителя.

Перед тем как начать составлять заметки, советую ознакомиться с моей заметкой для инициализации Vault ^[14].

Что нужно, чтобы начать?

Чтобы уже сейчас начать работать с Obsidian, вам достаточно:

• изучить Sandbox Vault и/или obsidian-markdown ^[10]

• прочитать мои must-have для начальных настроек приложения ^[15]

Более глубокое изучение

Личные советы

Версии файлов

Не знаю, будете ли вы сохранять свой Vault в Git / GitHub / GitLab, но в любом случае вы сможете отслеживать версии, причём эта функция встроена по умолчанию! Если вы перейдёте в Settings -> Core Plugins -> File Recovery, то увидите, что каждые 5 минут создаётся снимок ваших .md-файлов. Эти снимки хранятся неделю, и вы можете посмотреть каждый из них для любой заметки, кликнув на View. Очень полезная фишка, которая спасает в важные моменты (особенно когда удаляете файл из системной корзины ноутбука 😅).

Топики

Чтобы ваши заметки можно было удобно читать, используйте топики (заголовки). Благодаря им вы, например, можете прямо сейчас найти в правом верхнем углу иконку списка, кликнуть на неё и увидеть выжимку того, что есть в этой заметке. Так что топики — это прям must-have. Такое же меню, как и тут на GitHub, вы всегда можете открыть и в Obsidian (оно находится в правом верхнем углу в виде значка из трёх полосок).

Callout-ы

Помимо топиков в вашей власти так называемые callout-ы. О них было написано в Sandbox Vault, однако там есть опечатки (возможно, просто устаревшая версия). Для этого можно использовать готовые списки:

• Callouts_for_GitHub ^[16]

• Callouts_for_Obsidian ^[17]

Важно отметить, что callout-ы для GitHub работают в Obsidian, но в обратную сторону это не работает. Так что будьте внимательны. И ещё одно важное НО: GitHub-callout-ы не поддерживают заголовки, так что вместо > [!tip] Мегасовет! придётся писать просто > [!tip]. Также в Obsidian очень удобно делать сворачиваемые колауты с помощью знаков + или - (например, > [!note]- или > [!note]+), но на GitHub эта функция не поддерживается.

Чтобы увидеть, как выглядят обсидиановские callout-ы, сохраните эту заметку в свой Vault. Крайне рекомендую их использовать пореже, чтобы не привыкать. GitHub их обеспечить не может. Мне они понадобились только для публикации сайта на Quartz (подробнее в разделе «Публикация» ниже).

Расположение файлов в дереве

Слева в дереве сначала располагаются папки, а затем файлы. Между собой они сортируются в порядке кодов из Unicode.

Как упорядочить файлы и папки по-своему?

Если вы хотите отправить какую-то папку на самый верх, то можете воспользоваться следующей упорядоченной цепью:

!файл -> #файл -> @файл -> _файл -> 01_файл -> A_файл

Также стоит отметить, что всякая английская буква младше всякой русской и что никто не мешает вам задать порядок следующим образом:

01_файл -> 02_файл -> ...

Сохранение смысла заметок

Также многие на YouTube рекомендуют в каждой папке хранить главную заметку, которая опишет, что в текущей папке находится. Очень полезно, когда заметок становится так много, что не сыскать ни конца, ни начала. Аналог такого на GitHub — README-файлы.

Hot Keys

Горячие клавиши (англ. Hot Keys) — это отличный способ ускорить вашу работу с ноутбуком в разы. Не игнорируйте их. Да, и без них можно обойтись, но ведь и без Obsidian вы могли бы обойтись.

Горячих клавиш так много, что люди зачастую опускают руки сразу при начале изучения этих связок. Оно и понятно: этих горячих клавиш существуют сотни, если не тысячи. Однако есть важное НО: из них вам понадобятся максимум 20. Об этом вам никто не скажет.

Про них я написал в заметке HotKeys ^[18]. Там же есть раздел для Obsidian ^[19].

Главной связкой клавиш для Obsidian служит сочетание Ctrl + E, позволяющее переключать режим чтения на редактирование и наоборот.

Web Clipper

Помимо самого приложения obsidianmd/obsidian-releases ^[20] в репозитории компании Obsidian.md ^[21] есть и другой немалый проект — obsidianmd/obsidian-clipper ^[22]. Перейдя по ссылке, вы откроете README.md, в котором будет пара слов о том, что вообще это за репозиторий, и будет выбор магазина для установки расширения в браузер. Из репозиториев Obsidian ещё есть obsidianmd/obsidian-api ^[23], но его применение для меня пока остаётся загадкой — только если вы строите второй мозг ^[24] по Карпатому (что, как мне кажется, дело бессмысленное) или что-то в этом духе.

Очень рекомендую это расширение, если вы часто видите страницу, содержание которой хочется сохранить себе на память ^[25] — будь то важная статья о версионировании в современной индустрии или маленькая автобиография футболиста. Расширение позволит скачивать в формате .md весь текст сайта, поддерживая разделения по топикам и вписывая в начало заметки ссылку на сайт.

Синхронизация

Чтобы синхронизировать свой Vault между устройствами или просто хранить где-то помимо вашего ПК, есть несколько вариантов:

1. Самый простой — через Obsidian Sync ^[26] (4$ в месяц).

2. Через Google, Яндекс или другой диск (цена только за ваш диск). Крайне рекомендую в таком случае прибегнуть к следующей архитектуре, чтобы не синхронизировать папку .obsidian (если не знаете, почему её и прочие скрытые папки не стоит синхронизировать, спросите у ИИ):

   • Папка Storage

     • Папка .obsidian

     • Папка для синхронизации с вашим диском

3. При помощи GitHub через создание private-репозитория (бесплатно). Для синхронизации между устройствами (в том числе мобильными) советую прочитать этот гайд (в нём будет также рассказано, как запускать коммиты автоматически и периодически): Obsidian+GitHub вместо Notion: синхронизация, бекап и версионность (3-в-1) / Хабр ^[27].

Забавно, что чем дешевле вариант, тем он проще.

Спустя почти полгода активного пользования Obsidian для себя я решил разделить все свои файлы: вести заметки в Obsidian и синхронизировать через GitHub (3-м способом из вышеперечисленных), а все остальные файлы оставить на Google Диске. О том, почему не стоит использовать GitHub для всех-всех своих файлов, я рассказывать тут не стану, просто скажу, что:

1. отправлять файлы более 100 МБ на GitHub нельзя;

2. клонировать репозиторий объёмом более 2 ГБ становится задачкой со звёздочкой (или даже двумя);

3. будет просто полезно разделить ваши файлы на «Для работы/учёбы/IT» и «Личное».

Публикация

Obsidian хорош ещё и тем, что любой ваш Vault очень просто превратить в сайт, т. е. опубликовать. Есть два способа:

• Напрямую через Obsidian Publish ^[28] ($8 в месяц).

• Через Quartz ^[29] (бесплатно).

Второй способ довольно сложный, поэтому если вам и вправду нужно опубликовать заметки, советую воспользоваться моим уже настроенным шаблоном ^[30] (пример того, как это будет выглядеть: https://sergeypugin.github.io/itmo-notebook/ ^[31]).

Сама документация Obsidian — это и есть Vault, опубликованный на сайте. Перейдя по ссылкам, вы увидите, как будет выглядеть ваш Vault после публикации.

На этом у меня всё, буду рад услышать пару слов про ваш опыт ^[32] работы с Obsidian и про ваши “лайфхаки”