Описание

Проект содержит шаблон для распределенной работы команды с Obsidian(ссылка).

Позволяет организовать распределенную Базу знаний (Вики) для команды.

Из него может быть развернут публичный статический сайт. Например на платформе GitHub Pages(ссылка).

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

Настройка

1. Скачайте и установите Obsidian(ссылка) для свой ОС и установите его.
2. Клонируйте себе данный репозиторий. Выберите желаемую папку, и внутри нее в терминале выполните команду:

git clone [email protected]:medphisiker/template_obisdian.git

Эта директория станет хранилищем для всех файлов и настроек Obsidian, она станет его Vault.

Далее будем называть эту папку Obsidian Git Vault.

3. Удаляем папку .git внутри этой папки

Этот репозиторий шаблон, который мы не хотим менять.

4. Создаем новый удаленный репозиторий на GitHub/Gitlab с нужным нам именем репозитория.

Выполняем стандартные команды команды от GitHub/Gitlab, чтобы отправить в удаленный репозиторий (push) все имеющиеся файлы.

git init --initial-branch=main

git config --local user.name "YourName YouSurname"
git config --local user.email "[email protected]"

git remote add origin <you_repository_ssh_link>

git add .
git commit -m "Initial commit"
git push --set-upstream origin main

теперь в этом удаленном git-репозитории будет хранится База знаний команды.

Будем называть его Obsidian Git repo.

5. Скачайте архив template_obisdian_cfg.zip из Google Drive папки ссылка.
6. Распакуйте скаченный архив внутри папки Obsidian Git Vault.
7. Проверьте полученную структуру каталога Obsidian Git Vault.

Она должна выглядеть так:

├───.obsidian
│   └───plugins
│       ├───better-export-pdf
│       ├───image-captions
│       ├───obsidian-excalidraw-plugin
│       ├───obsidian-paste-image-rename
│       ├───oz-clear-unused-images
│       └───tag-wrangler
├───cards
├───files
│   └───Excalidraw
│       └───Scripts
│           └───Downloaded
├───projects
├───repo_pics
└───templates

Для этого на Windows можно открыть cmd-терминал, на Linux/Unix их терминал внутри папки Obsidian Git Vault и выполнить команду:

tree

8. Выбираем в программе Obsidian в качестве нашего хранилища папку Obsidian Git Vault.

Шаг 1 Запускаем программу Obsidian

Если у Вы уже используете Obsidian, он откроет ваше личное хранилище.

Вам нужно будет переключится на хранилище указав нашу папку Obsidian Git Vault.

Если программы Obsidian ранее не было у вас на ПК она сама при своем первом запуске предложит Вам выбрать папку для хранилища.

Шаг 2 Выбираем папку Obsidian Git Vault как хранилище

Шаг 3 Доверится автору и включить плагины

После выбора папки Obsidian Git Vault в качестве хранилища для заметок, появится окно.

Оно сообщит Вам, что данное хранилище использует набор сторонних плагинов для Obsidian.

Так и было задумано, они были в архиве template_obisdian_cfg.zip, который мы распаковывали ранее.

Соглашаемся с активацией сторонних плагинов внутри нашего хранилища.

Шаг 4 Настраиваем Git

За этот шаг выражаем благодарность Юлии (ссылка на профиль GitHub)

• Кажется это нюанс работы Obsidian на Windows, но это не точно.
• Лучше сделать эту настройку на всех ОС.

После открытия Markdown-файлов заметок в Obsisidian, даже если содержание заметок не было изменено, git будет показывать нам, что Markdown-файл был изменен. При этом он не сможет отобразить изменения в содержании файла потому, что их нет.

Отредактируем настройки git так, чтобы он показывал нам в качестве измененных файлов только те заметки, содержание, которых было действительно изменено (ссылка на источник).

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

Для этого в каталоге нашего репозитория Obsidian Git Vault откроем файл .git/config. Открывать лучше редактором, который отображает все спец. символы, например, Notepad++ или вашей любимой IDE. Добавим в раздел [core] такие строки:

[core]
	bare = false
	autocrlf = false
	trustctime = false

У разных версий git будут отличаться знаки разделителя блоков в форматировании файла .git/config. При редактировании опирайтесь формат на вашего файла .git/config.

После этого нужно будет перезапустить git, чтобы наши изменения локальных настроек git (на уровне данного репозитория) вступили в силу. Можно выполнить специальные команды в терминале, которые будут немного отличаться для разных версий git и ОС или поступить более простым и универсальным способом - перезагрузить ОС.

Шаг 5 Используем распределенную базу знаний

1. Используем Obsidian, чтобы создавать заметки в формате Markdown-файлов.

• Синтаксис Markdown: подробная шпаргалка для веб-разработчиков ссылка
• Курс по Obsidian ссылка
• An Introduction to Obsidian Properties ссылка
• How to Make a Template in Obsidian ссылка

2. Используем плагины Obsidian, которые мы активировали:

• Excalidraw (ссылка) - крутой плагин для создания диаграмм, редактирования картинок и т.д.

Можно использовать вместо Miro совместно всеми участниками проекта =)

Базовый набор его возможностей:

• Obsidian-Excalidraw 1.2.0 Walkthrough Part 1/10 (смотрим все 10 штук) ссылка на 1 видео
• YouTube Канал автора плагина ссылка
• Онлайн сервис Excalidraw на взаимодействии с которым построен плагин ссылка

Будем в нем рисовать красивые схемы/диаграммы/брейнштормить и т.д.

• Better Export PDF - позволяет экспортировать заметки в pdf файлы. Exalidraw - диаграммы будут преобразованы в картинки
• Image Captions - позволяет делать подписи рисункам
• Paste image rename - автоматически переименовывает картинки, которые мы вставляем в имя заметки.
• Clear Unused Images - перемещает все неиспользуемые картинки в корзину.

Использовать осторожно, плагины от Exalidraw он тоже стремится удалить.