🧠 Инструкция по работе с Neurolab Wiki
Добро пожаловать в нашу общую базу знаний! Эта вики построена на движке Quartz. Вы пишете и редактируете заметки в привычном Obsidian, а система сама превращает их в красивый веб-сайт.
🔗 Ссылка на нашу вики
🔐 Шаг 0: Получение доступа (Обязательно)
Поскольку наш репозиторий приватный, вам нужно получить персональное разрешение на доступ:
- Отправьте свой логин на GitHub Марии Голицыной (@MaryKul ник тг).
- Мария добавит вас в список коллабораторов.
- Важно: Проверьте свою электронную почту (на которую зарегистрирован GitHub) и примите приглашение. Пока вы не нажмете кнопку “Accept Invitation”, вы не сможете скачать файлы.
🛠 Выберите ваш способ работы
❓ Умеете ли вы пользоваться терминалом и Git?
✅ ДА, я умею пользоваться терминалом
Этот путь позволит вам работать полностью внутри Obsidian.
- Инструменты: Убедитесь, что установлены Obsidian и Git.
- Клонирование:
git clone git@github.com:Mary-Kul/neurolab_wiki.git - Настройка в Obsidian: Откройте в скачанной папке папку
contentкак Vault (хранилище). - Синхронизация: * Установите плагин в ОбсидианеGit через настройки (Community Plugins).
- Настройте его на автоматический
Pullпри запуске иPushпри сохранении/выходе. - Перед началом работы всегда делайте
git pull.
- Настройте его на автоматический
❌ НЕТ, я предпочитаю визуальный интерфейс
Самый надежный способ для тех, кто не хочет возиться с кодом и токенами.
-
Инструменты: Скачайте Obsidian и GitHub Desktop.
-
Настройка:
- В GitHub Desktop войдите в аккаунт и выберите
File→Clone Repository→neurolab_wiki. - В Obsidian нажмите
Open folder as vaultи укажите эту скачанную папку.
- В GitHub Desktop войдите в аккаунт и выберите
-
Настройка в Obsidian: Нажмите Open folder as vault и выберите именно папку
contentвнутри скачанного репозиторияneurolab_wiki.- Так вы будете видеть только заметки и статьи, не отвлекаясь на системные файлы сайта.
-
Синхронизация: * Для варианта А (Git-плагин): В настройках плагина Obsidian Git укажите путь к основной папке (на уровень выше), чтобы он видел скрытую папку
.git.- Для варианта Б (GitHub Desktop): Просто пишите в Obsidian. Программа GitHub Desktop сама увидит изменения во всем репозитории, включая папку
content.
- Для варианта Б (GitHub Desktop): Просто пишите в Obsidian. Программа GitHub Desktop сама увидит изменения во всем репозитории, включая папку
❌ НЕТ, я предпочитаю визуальный интерфейс
Самый надежный способ для тех, кто не хочет возиться с кодом и токенами.
- Инструменты: Скачайте Obsidian и GitHub Desktop.
- Настройка:
- В GitHub Desktop войдите в аккаунт и выберите
File→Clone Repository→neurolab_wiki. - В Obsidian нажмите
Open folder as vaultи выберите папкуcontentвнутриneurolab_wiki.
- В GitHub Desktop войдите в аккаунт и выберите
- Как публиковать изменения:
- Пишите текст в Obsidian. Все изменения сохраняются на компьютере автоматически.
- Когда будете готовы выложить их на сайт: откройте GitHub Desktop.
- Слева внизу в поле Summary напишите коротко, что изменили (например: “Добавил статью про ЭМГ”), и нажмите синюю кнопку Commit to main.
- Нажмите кнопку Push origin в верхней панели.
📝 Правила работы с контентом
- Где писать: Поскольку вы открыли папку
/contentкак Vault, просто создавайте файлы в корне или подпапках — они все автоматически попадут на сайт. - Синхронизация (Критично!): Перед тем как начать писать, всегда делайте Pull/Fetch origin в GitHub Desktop или терминале. Это загрузит правки коллег и предотвратит конфликты.
- Картинки: Просто вставляйте их через
Ctrl+V. Obsidian сам положит их в папку вложений, и они появятся на сайте. - Названия файлов: Не используйте спецсимволы (
#,%,&) и слишком длинные названия, чтобы ссылки на сайте не ломались.
Если что-то не получается, выдает ошибку или «не нажимается» — пишите Марии!