109 lines
2.4 KiB
Markdown
109 lines
2.4 KiB
Markdown
# ParaBox Wiki (Astro + Starlight)
|
||
|
||
Готовый шаблон wiki-сайта для Minecraft-сервера с акцентом на:
|
||
|
||
- простое редактирование через Markdown (`.md`);
|
||
- чистую структуру разделов;
|
||
- атмосферный pastel fantasy-tech стиль;
|
||
- удобную навигацию (sidebar, верхние быстрые ссылки, оглавление, поиск).
|
||
|
||
## Запуск
|
||
|
||
```bash
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
Продакшн-сборка:
|
||
|
||
```bash
|
||
npm run build
|
||
npm run preview
|
||
```
|
||
|
||
## Запуск в Docker
|
||
|
||
Собрать и запустить контейнер:
|
||
|
||
```bash
|
||
docker compose up -d --build
|
||
```
|
||
|
||
Проверка в браузере:
|
||
|
||
`http://127.0.0.1:4321`
|
||
|
||
Остановить:
|
||
|
||
```bash
|
||
docker compose down
|
||
```
|
||
|
||
Логи:
|
||
|
||
```bash
|
||
docker compose logs -f
|
||
```
|
||
|
||
## Публичная ссылка через Cloudflare Tunnel
|
||
|
||
Если нет публичного IP и проброса портов:
|
||
|
||
```bash
|
||
cloudflared tunnel --url http://127.0.0.1:4321 --protocol http2 --edge-ip-version 4
|
||
```
|
||
|
||
Используй ссылку `https://*.trycloudflare.com` из вывода команды.
|
||
|
||
## Где редактировать контент
|
||
|
||
Все страницы хранятся в:
|
||
|
||
`src/content/docs/`
|
||
|
||
Каждая страница имеет frontmatter:
|
||
|
||
```yaml
|
||
---
|
||
title: Название страницы
|
||
description: Короткое описание
|
||
---
|
||
```
|
||
|
||
## Как добавить новую страницу
|
||
|
||
1. Создай новый `.md`-файл в `src/content/docs/`.
|
||
2. Добавь `title` и `description` в frontmatter.
|
||
3. Напиши контент Markdown.
|
||
4. Добавь пункт меню в `astro.config.mjs` -> `sidebar`.
|
||
|
||
Шаблон для копирования: `src/content/docs/templates/new-page-template.md`.
|
||
|
||
## Как редактировать меню
|
||
|
||
Навигация задается в `astro.config.mjs`:
|
||
|
||
- `sidebar` — боковое меню;
|
||
- `components.Header` — верхняя панель с быстрыми ссылками;
|
||
- `editLink.baseUrl` — ссылка "Редактировать страницу".
|
||
|
||
## Полезные Markdown-блоки Starlight
|
||
|
||
```md
|
||
:::note
|
||
:::
|
||
|
||
:::tip
|
||
:::
|
||
|
||
:::caution
|
||
:::
|
||
|
||
:::danger
|
||
:::
|
||
```
|
||
|
||
Также поддерживаются списки, таблицы, цитаты, code-блоки и `<details>`.
|
||
|
||
|