Skip to content

Repository files navigation

Mind Maps

Коллекция дизайн-документа и заметок проекта Horizon =][=, опубликованная в виде статического сайта на базе Quartz 5.

🛠 Два способа работы с проектом

В зависимости от ваших целей, вы можете выбрать один из двух путей:

Путь 1: Только чтение и редактирование карт (Рекомендуется)

Если вам нужно просто просматривать, структурировать или писать заметки, вам не нужно ничего устанавливать через терминал.

  • Скачайте (или клонируйте) этот репозиторий.
  • Установите Obsidian.
  • Откройте Obsidian -> "Открыть папку как хранилище" -> выберите папку content/ в этом проекте.

Obsidian идеально понимает весь синтаксис Quartz (wikilinks, callouts, графики), поэтому вы получите красивый и удобный интерфейс для работы с текстом без запуска самого сайта.

Путь 2: Локальная разработка и предпросмотр сайта

Если вы хотите видеть, как карты выглядят именно как веб-сайт (с финальными стилями, кнопками, поиском), вам потребуется развернуть локальный сервер. Можно так же скачать Obsidian, для более комфортной работы с файлами.

⚠️ Требования для развертывания

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

Node.js: версия v22 или выше
npm: версия v10.9.2 или выше

Проверить версии можно командами: node -vnpm -v

Установка и локальный запуск

Если вы только что клонировали этот репозиторий на новый компьютер, выполните следующие шаги:

# 1. Клонируем репозиторий
git clone https://github.com/horizon-dev-team/Mind-Maps.git
cd Mind-Maps

# 2. Устанавливаем зависимости (строго по lock-файлу)
npm ci

# 3. Устанавливаем плагины, используемые в проекте
npx quartz plugin install --latest

# 4. Запускаем локальный сервер для предпросмотра
npx quartz build --serve

После выполнения последней команды сайт будет доступен в браузере по адресу: http://localhost:8080

Примечание по редакторам: Если вы выбрали Путь 2, вы можете использовать любой текстовый редактор (VS Code, Notepad++ и т.д.) для изменения файлов в папке content/. Благодаря hot-reload, изменения будут автоматически отображаться на локальном сайте в браузере.

Как с этим работать

Q: Где хранится контент?

A: Все карты и заметки лежат в папке content/. Вы можете создавать там новые .md файлы - Quartz автоматически подхватит их при сохранении (благодаря hot-reload).

Q: Как обновить сайт на сервере?

A: После того как вы закоммитили изменения, используйте встроенную команду синхронизации: npx quartz sync

🔧 Решение проблем (Troubleshooting)

Ошибки сборки после чистого клонирования: Если npm ci или запуск завершились с ошибкой связанных с плагинами, выполните принудительное обновление плагинов: npx quartz plugin install --latest

Ошибки версий Node: Убедитесь, что вы используете менеджер версий (например, nvm), так как Quartz 5 требует строго Node v22+. Команда для переключения: nvm use 22.

Этот проект работает на Quartz - быстром генераторе статических сайтов для публикации заметок.

About

Дизайн-документ Horizon =][=

Resources

Stars

1 star

Watchers

0 watching

Forks

Contributors

Languages

Generated from jackyzha0/quartz