🧠 Инструкция по работе с Neurolab Wiki

Добро пожаловать в нашу общую базу знаний! Эта вики построена на движке Quartz. Вы пишете и редактируете заметки в привычном Obsidian, а система сама превращает их в красивый веб-сайт.

🔗 Ссылка на нашу вики


🔐 Шаг 0: Получение доступа (Обязательно)

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

  1. Отправьте свой логин на GitHub Марии Голицыной (@MaryKul ник тг).
  2. Мария добавит вас в список коллабораторов.
  3. Важно: Проверьте свою электронную почту (на которую зарегистрирован GitHub) и примите приглашение. Пока вы не нажмете кнопку “Accept Invitation”, вы не сможете скачать файлы.

🛠 Выберите ваш способ работы

❓ Умеете ли вы пользоваться терминалом и Git?

✅ ДА, я умею пользоваться терминалом

Этот путь позволит вам работать полностью внутри Obsidian.

  1. Инструменты: Убедитесь, что установлены Obsidian и Git.
  2. Клонирование:
    git clone git@github.com:Mary-Kul/neurolab_wiki.git
     
  3. Настройка в Obsidian: Откройте в скачанной папке папку content как Vault (хранилище).
  4. Синхронизация: * Установите плагин в ОбсидианеGit через настройки (Community Plugins).
    • Настройте его на автоматический Pull при запуске и Push при сохранении/выходе.
    • Перед началом работы всегда делайте git pull.

❌ НЕТ, я предпочитаю визуальный интерфейс

Самый надежный способ для тех, кто не хочет возиться с кодом и токенами.

  1. Инструменты: Скачайте Obsidian и GitHub Desktop.

  2. Настройка:

    • В GitHub Desktop войдите в аккаунт и выберите File Clone Repository neurolab_wiki.
    • В Obsidian нажмите Open folder as vault и укажите эту скачанную папку.
  3. Настройка в Obsidian: Нажмите Open folder as vault и выберите именно папку content внутри скачанного репозитория neurolab_wiki.

    • Так вы будете видеть только заметки и статьи, не отвлекаясь на системные файлы сайта.
  4. Синхронизация: * Для варианта А (Git-плагин): В настройках плагина Obsidian Git укажите путь к основной папке (на уровень выше), чтобы он видел скрытую папку .git.

    • Для варианта Б (GitHub Desktop): Просто пишите в Obsidian. Программа GitHub Desktop сама увидит изменения во всем репозитории, включая папку content.

❌ НЕТ, я предпочитаю визуальный интерфейс

Самый надежный способ для тех, кто не хочет возиться с кодом и токенами.

  1. Инструменты: Скачайте Obsidian и GitHub Desktop.
  2. Настройка:
    • В GitHub Desktop войдите в аккаунт и выберите File Clone Repository neurolab_wiki.
    • В Obsidian нажмите Open folder as vault и выберите папку content внутри neurolab_wiki.
  3. Как публиковать изменения:
    • Пишите текст в Obsidian. Все изменения сохраняются на компьютере автоматически.
    • Когда будете готовы выложить их на сайт: откройте GitHub Desktop.
    • Слева внизу в поле Summary напишите коротко, что изменили (например: “Добавил статью про ЭМГ”), и нажмите синюю кнопку Commit to main.
    • Нажмите кнопку Push origin в верхней панели.

📝 Правила работы с контентом

  • Где писать: Поскольку вы открыли папку /content как Vault, просто создавайте файлы в корне или подпапках — они все автоматически попадут на сайт.
  • Синхронизация (Критично!): Перед тем как начать писать, всегда делайте Pull/Fetch origin в GitHub Desktop или терминале. Это загрузит правки коллег и предотвратит конфликты.
  • Картинки: Просто вставляйте их через Ctrl+V. Obsidian сам положит их в папку вложений, и они появятся на сайте.
  • Названия файлов: Не используйте спецсимволы (#, %, &) и слишком длинные названия, чтобы ссылки на сайте не ломались.

Если что-то не получается, выдает ошибку или «не нажимается» — пишите Марии!