Начало работы с CastleWiki

Узнайте, как настроить, сконфигурировать и использовать CastleWiki для ваших задач документирования.

Адена

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

Природное Лечение (Уровень 4) Перед началом работы убедитесь, что у вас есть следующее:

• Современный веб-браузер (Chrome, Firefox, Safari или Edge)
• Базовые знания HTML (для редактирования контента)
• Текстовый редактор для изменения файлов
• PHP 5.4+ (для запуска локального сервера)

Установка

Чтобы начать работу с CastleWiki, выполните следующие простые шаги:

1. Загрузите файлы

   Клонируйте репозиторий или скачайте ZIP-файл на свой локальный компьютер.

   git clone https://github.com/yourusername/castlewiki.git

2. Перейдите в директорию

   Откройте терминал или командную строку и перейдите в папку CastleWiki.

   cd castlewiki

3. Запустите сервер

   Запустите локальный сервер, чтобы просмотреть свою вики:

   php -S localhost:8000

   В Windows вы также можете дважды щелкнуть файл start-server.bat.

4. Откройте в браузере

   Откройте ваш браузер и перейдите по адресу http://localhost:8000

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

Понимание структуры файлов CastleWiki поможет вам настроить его под свои нужды:

Создание контента

CastleWiki позволяет легко создавать и организовывать вашу документацию:

Добавление страниц

1. Создайте новый PHP-файл в директории pages/
2. Назовите файл желаемым URL-идентификатором (например, my-page.php для /my-page)
3. Добавьте ваш контент, используя HTML
4. Добавьте страницу в боковую панель навигации в layouts/main.php (опционально)
5. Всё! Ваша страница автоматически доступна по адресу /your-page-name

Настройка боковой панели

Навигация на боковой панели определена в layouts/main.php. Чтобы добавить новый элемент:

<li class="<?= is_active(\'page-name\') ? \'active\' : \'\' ?>">
    <a href="<?= url(\'page-name\') ?>">Заголовок страницы</a>
</li>

Для вложенных элементов (подменю):

<li>
    <a href="#">Категория</a>
    <ul class="submenu">
        <li><a href="<?= url(\'page1\') ?>">Страница 1</a></li>
        <li><a href="<?= url(\'page2\') ?>">Страница 2</a></li>
    </ul>
</li>

Вспомогательные функции

CastleWiki включает вспомогательные функции для упрощения разработки:

• url(\'page-name\') - Генерирует правильный URL для страницы
• is_active(\'page-name\') - Проверяет, является ли текущая страница активной

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

Теперь, когда CastleWiki работает, вот рекомендуемые следующие шаги:

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