Skip to content

Начало работы ​

Добро пожаловать в mineproj! Это руководство поможет вам создать ваш первый сайт-портфолио проектов.

Предварительные требования ​

  • Node.js 22 или новее
  • pnpm 10 (установка через npm install -g pnpm)

Создание нового сайта ​

Самый быстрый способ начать — использовать инструмент для создания каркаса:

bash
npx create-mineproj my-portfolio
cd my-portfolio
pnpm dev

Откройте http://localhost:5173 в вашем браузере, чтобы увидеть ваш сайт.

Структура проекта ​

my-portfolio/
├─ mineproj.config.ts      # Конфигурация сайта
├─ data/
│  ├─ projects/             # Данные проектов (JSON + Markdown)
│  │  └─ my-project/
│  │     ├─ index.json      # Метаданные проекта
│  │     └─ body.md         # Содержимое проекта
│  ├─ profile.json          # Ваш профиль
│  └─ tags.json             # Определения тегов
├─ public/                  # Статические ресурсы (изображения, PDF и т.д.)
└─ dist/                    # Результат сборки (генерируется)

Добавление проекта ​

Создайте новую директорию в data/projects/:

bash
mineproj new my-project

Это создаст data/projects/my-project/index.json и data/projects/my-project/body.md. Отредактируйте JSON-файл, чтобы задать метаданные проекта.

Сборка для продакшена ​

bash
pnpm build

Результат помещается в dist/. Предварительный просмотр локально:

bash
pnpm preview

Следующие шаги ​

Released under the Apache-2.0 License.