Обсидиан: Организация базы знаний с облаком и доступом без интернета.

Некоторые программисты предпочитают ввести собственную базу знаний. К такой мысли приходят из-за потребности документировать ошибки и их решения. Как бывает: с проблемой сталкивался, а путь к решению уже не помню.

База знаний может служить инструментом для хранения вашего опыта. У каждого человека есть персональные требования к такой базе. В этом материале поделимся нашими критериями к функционалу такой базы знаний, возможности организации и использования на разных устройствах.

Для начала нужно выделить требования к базе знаний. Помимо возможности бесплатного использования, образовалось три критерия:

Работа в нескольких операционных системах:

В нашем случае важно работать с базой знаний на Ubuntu, Windows, Android и iOS. Каждый программист может использовать в своей работе несколько операционных систем, не всегда в рамках одного устройства. В случае, если несколько систем на одном компьютере, можно выделить общую память для размещения базы знаний. Таким образом, база знаний хранится в одном экземпляре, но доступна из нескольких операционных систем одного компьютера. Также требуется синхронизировать её с другими устройствами, для этой задачи выделили второе требование.

Возможность работать с облаком и синхронизировать:

Когда используется несколько устройств, нужна возможность синхронизации данных в автоматическом режиме. База знаний представляет собой множество файлов с информацией, поэтому после редактирования потребовалось много времени на обновление всего хранилища. В этом случае достаточно выгрузить только то, что изменилось. На помощь приходит Git – внешний репозиторий, традиционно размещаемый на GitHub или GitLab. Также можно использовать российский сервис GitFlic.

Интерфейс:

Интерфейс софта, который мы используем в повседневной работе, должен быть интуитивно понятным, в частности, на мобильных устройствах. Также должна присутствовать поддержка русского языка. Важно, чтобы процесс чтения и поиска были быстрыми, поскольку главная функция базы знаний – это нахождение нужной информации. Логичная навигация по структуре также важна, однако за неё отвечает сам автор. К этой возможности мы ещё вернёмся.

Open Source:

Open Source – это открытый исходный код программы. Можно найти различные преимущества и недостатки, но главное преимущество для нас – это возможность удостоверится в отсутствии вредоносных функций, чтобы быть спокойным в стабильности и работоспособности сервиса.

Даже если в России заблокируют GitHub или GitLab, мы сможем перенести всё на GitFlic, подобным образом поступаем с софтом для базы знаний, чтобы никто не смог сказать: Знаешь, но сегодня не дадим тебе доступ к базе знаний. При этом, файлы базы знаний составляются с помощью разметки Markdown, что хорошо, поскольку есть возможность перенести файлы базы знаний на другие платформы.

Чек-лист:

1. Всё должно быть бесплатным;
2. Необходима поддержка работы с Git и синхронизации через внешний репозиторий;
3. База знаний должна работать на Windows, Ubuntu, Android, iOS и macOS;
4. Интерфейс который можно будет настроить;
5. Программа должна быть основана на Open Source;
6. Разметка документа с информацией Markdown или @HTML.

Мы попробовали несколько программ и в соответствии со всеми критериями подобрали вариант – это Obsidian.

Свободно и бесплатно:

Obsidian – это менеджер заметок, который поддерживает работу как на компьютерах, так и на мобильных устройствах. Для личного использования программа распространяется без лицензий – бесплатно и навсегда. Если вы переживаете, что посвятите свою жизнь систематизации знаний, затем они в момент сгорят или запросят оплаты подписки – эта программа позволит забыть о таком страхе.

Сами создаём структуру:

Мотивация вести базу знаний в специализированной программе – возможность самостоятельно выстраивать логические связи между любыми её элементами. Можно создавать ссылки для перехода из одного документа в другой, выстроить поиск по тегам, чтобы оформить свою виртуальную библиотеку, или вставлять кусочек текста из другого документа как цитату. Obsidian сам проиндексирует базу знаний и построит удобный поиск и граф по которому можно визуально искать нужное.

Граф в Obsidian.

Синхронизация между устройствами:

Obsidian доступен для любых операционных систем – Windows, macOS, Linux, Android и iOS. При авторизации через один аккаунт вся база знаний будет незаметно синхронизироваться на различных устройствах. Для разработчиков, которые работают в команде, можно создать корпоративную папку – её сможет обновлять любой член вашей группы.

Предусмотренная разработчиком синхронизация строит денег, но можно без труда настроить её бесплатно – через Git, что будет удобно для программистов. Так все данные будут храниться в приватном репозитории, который смогут изучать и редактировать члены команды. Здесь будет и отслеживание изменений, и автоматическая отправка и получение. На Android и iOS дополнительно потребуется установить приложение mGit для работы с репозиторием с мобильных устройств.

Плагин «‎Obsidian Git».

Нет зависимости от интернета, вы сможете продолжить полноценную работу с базой знаний. Потом, когда соединение восстановится, все внесённые изменения автоматически отправляются во внешний репозиторий, если: установлен и настроен плагин Obsidian Git на автоматическую отправку и получения изменений. Поэтому, если вы часто летаете или ищете вдохновение в глухом лесу, это не помешает записать или вспомнить свои умные мысли. При этом есть приватность, ни у кого другого нет доступа к вашим заметкам – даже у разработчиков Obsidian.

В одном установленном экземпляре Obsidian вы можете вести более одной базы знаний, при этом настройки Obsidian не будут пересекаться между двумя базами знаний.

Делимся со всем миром:

Если хотите поделиться своей базой знаний с другими людьми, её можно за пару мгновений превратить в сайт. Obsidian предлагает собственный движок, который работает на всех операционных системах. Все ваши обновления моментально отображаются на сайте. Для комфорта и удобства гостей сможете тщательно настроить его дизайн.

Ещё две важных возможности поделится конкретной страницей в базе знаний это конвертировать её в PDF файл либо если вы работаете в команде с коллегами можете сразу дать Obsidian URL на нужную страницу. При переходе по такой URL, обсидиан сам откроит нужный файл и выделит нужный заголовок если на странице ссылались в определённое место.

Пример Obsidian URL: obsidian://open?vault=Личная база&file=GIT/README

Пример меню для работы со страницей.

Шаблоны страниц:

В момент написания документации, важно выдерживать одну и туже разметку текста и навигацию, для этого в настройках Obsidian можно указать папку, где хранятся шаблоны и создавать сколько угодно шаблонов. При создании новой заметки, можно вызвать комбинацией клавиш окно с поиском и выбором нужного шаблона, после чего этот шаблон заполняется в новой заметки.

В данном примере, 4 шаблона на выбор созданные автором базы знаний.

Кастомизация и гибкая настройка интерфейса:

По умолчанию есть возможность в Obsidian выбрать светлую или тёмную тему с выбором основного цвета. Однако для кастомизации и гибкой настройки интерфейса есть более чем 1 000 сторонних плагинов с официального сайта разработчика и тем оформления. Активные пользователи программы, которые нашли её полезной, создали надстройки для упрощения самых частых сценариев использования и готовы поделиться ими с пользователями со всего мира.

Для примера: плагины позволяют адаптировать Obsidian для написания формул с LaTeX, импортировать файлы с различными расширениями, извлекать данные с сайтов и из программ, встроить искусственный интеллект и работу с языками программирования.

Библиотека с темами для оформления интерфейса Obsidian.

Библиотека с плагинами для расширения функционала Obsidian.

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

Мы уже заценили последние фишки. А вы?