Meowrch Wiki

Общественная wiki для дистрибутива meowrch Linux — место, где собираются знания, гайды, туториалы и полезная информация от сообщества.

📖 Как внести свой вклад

1. Создание форка

# Создайте форк репозитория через GitHub интерфейс или используйте gh CLI
gh repo fork meowrch/meowrch.github.io --clone

# Или через утилиту git
git clone https://github.com/meowrch/meowrch.github.io

cd meowrch.github.io

2. Установка зависимостей

npm install

3. Создание и редактирование контента

Структура контента:

src/content/docs/
├── en/                  # Английская версия
│   ├── installation/    # Установка и настройка
│   ├── customization/   # Кастомизация и темы
│   ├── usage/          # Использование системы
│   └── optimization/   # Оптимизация производительности
└── ru/                 # Русская версия
    ├── installation/   # Установка и настройка
    ├── customization/  # Кастомизация и темы
    ├── usage/         # Использование системы
    └── optimization/  # Оптимизация производительности

Добавление новой статьи:

1. Создайте новый .md файл в соответствующей категории:

   • Для установки: src/content/docs/ru/installation/my-guide.md
   • Для кастомизации: src/content/docs/ru/customization/my-guide.md
   • Для оптимизации: src/content/docs/ru/optimization/my-guide.md
   • Для использования: src/content/docs/ru/usage/my-guide.md

2. Добавьте frontmatter в начало файла:

   ---
   title: "Название статьи"
   description: "Краткое описание статьи"
   ---
   
   # Название статьи
   
   Ваш контент здесь...

3. Используйте изображения (если нужно):

   • Поместите изображения в src/assets/
   • Вставьте в markdown: ![Alt текст](../../assets/image.png)

4. Запуск сервера разработки

npm run dev

Откройте http://localhost:4321 чтобы увидеть изменения в реальном времени.

5. Добавление новых статей

Для новых статей в существующих категориях: Ничего особенного делать не нужно! Просто создайте .md файл в нужной папке — Starlight автоматически добавит его в сайдбар.

6. Добавление новой категории

Если нужна новая категория (например, "troubleshooting"):

1. Создайте папки для обоих языков:

   mkdir -p src/content/docs/ru/troubleshooting
   mkdir -p src/content/docs/en/troubleshooting

2. Добавьте категорию в конфигурацию astro.config.mjs:

   sidebar: [
       // ... существующие категории
       {
           label: 'Troubleshooting',
           autogenerate: { directory: 'troubleshooting' },
           translations: { ru: 'Решение проблем' }
       }
   ]

3. Перезапустите dev сервер чтобы увидеть изменения.

6. Создание Pull Request

# Закоммитьте изменения
git add .
git commit -m "Добавлена статья: Название статьи"
git push origin main

# Создайте PR через GitHub или gh CLI
gh pr create --title "Добавлена статья: Название статьи" --body "Описание изменений"

🛠️ Команды разработки

Команда	Действие
npm install	Установка зависимостей
npm run dev	Запуск dev сервера на localhost:4321
npm run build	Сборка production версии в ./dist/
npm run preview	Предпросмотр собранной версии

📝 Советы по написанию

• Используйте понятный язык — помните, что статьи читают пользователи с разным уровнем подготовки
• Добавляйте примеры команд — практические примеры всегда полезны
• Структурируйте контент — используйте заголовки, списки, блоки кода
• Проверяйте ссылки — убедитесь что все ссылки работают
• Добавляйте скриншоты — визуальные примеры упрощают понимание

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

.
├── public/              # Статические файлы (favicon, etc.)
├── src/
│   ├── assets/          # Изображения и медиа файлы
│   ├── content/
│   │   └── docs/        # Markdown файлы с контентом
│   │       ├── en/      # Английская версия
│   │       └── ru/      # Русская версия
│   └── content.config.ts
├── astro.config.mjs     # Конфигурация Astro и Starlight
├── package.json
└── tsconfig.json