О Tiny Wiki

Tiny Wiki — это минималистичный онлайн-центр документации, который может работать в современных серверных средах, таких как apache+php или nginx+php.

Автор

• xiaozhuai xiaozhuai7@gmail.com.

Руководство

Конфигурация

Файл конфигурации по умолчанию находится в framework/config.default.json. Если вам нужно изменить конфигурацию, просто создайте файл config.custom.json в каталоге проекта. Все параметры конфигурации могут быть перезаписаны.

Книги

Если это строка, то это каталог книг (относительно каталога проекта), например /samples/sample1. Вы также можете предоставить массив для настройки нескольких книг, например:

[
    {
        "path": "/samples/sample1",
        "uri": "/"
    },
    {
        "path": "/samples/sample2",
        "uri": "/sample2"
    }
]

Если вы предоставляете строку /samples/sample1, эквивалентная конфигурация будет такой:

[
    {
        "path": "/samples/sample1",
        "uri": "/"
    }
]

Совет: благодаря функции многомодульной документации в TinyWiki легко реализовать многоязычность для одной книги. Создайте файл config.custom.json и настройте раздел books следующим образом:

[
    {
        "path": "/books/xx_sdk_wiki_cn",
        "uri": "/xx_sdk_wiki"
    },
    {
        "path": "/books/xx_sdk_wiki_cn",
        "uri": "/xx_sdk_wiki_cn"
    },
    {
        "path": "/books/xx_sdk_wiki_en",
        "uri": "/xx_sdk_wiki_en"
    }
    {
        "path": "/books/xx_sdk_wiki_jp",
        "uri": "/xx_sdk_wiki_jp"
    },
    {
        "path": "/books/xx_sdk_wiki_kr",
        "uri": "/xx_sdk_wiki_kr"
    }
]

Затем вы можете получить доступ к соответствующей языковой версии через xx_sdk_wiki_${region}. Вы даже можете установить китайский язык по умолчанию, чтобы при доступе к xx_sdk_wiki вы попадали на китайскую версию:

{
    "path": "/books/xx_sdk_wiki_cn",
    "uri": "/xx_sdk_wiki"
}

Site_root

Каталог сайта, например, если вы поместите проект в каталог /var/www/wiki, вам необходимо установить его в /wiki. Если вы находитесь в /var/www, используйте значение по умолчанию /.

Theme

Каталог темы. Вы можете разработать свою собственную тему, но обратите внимание, что тема должна содержать как минимум файлы шаблонов view/layout.php и view/login.php. Конечно, вы можете написать свои собственные файлы шаблонов.

Настройка книги

В файле book.json:

Тема

Переопределяет тему, установленную в глобальных настройках, что означает, что вы можете использовать разные темы для разных книг.

Заголовок

Устанавливает название книги.

Пароль

Установите пароль, который можно не устанавливать или оставить пустым, если пароль не требуется.

Duoshuo

Установите идентификатор duoshuo, duoshuo — это плагин для социальных комментариев. Если вы хотите отключить эту функцию, установите для этого параметра пустое значение или не устанавливайте его вообще.

Меню

Настройте структуру каталогов.

404.md устанавливает пользовательскую страницу 404.

О маршрутизации

Например, /xxx будет последовательно сопоставляться со следующими правилами, пока не будет найдено совпадение:

1. xxx.md
2. xxx/index.md
3. 404.md
4. Содержимое по умолчанию для 404:

# 404
404 Not Found

Примеры книг

Примеры книг взяты из leetcode-solution, авторы:

• 陈心宇 collectchen@gmail.com
• 张晓翀 xczhang07@gmail.com
• SiddonTang siddontang@gmail.com

Спасибо!

В этом проекте я добавил два примера книг, которые помогут вам настроить многомодульную документацию. Подробнее см. выше.

Пример 1: http://115.159.31.66/tiny_wiki/

Пример 2: http://115.159.31.66/tiny_wiki/sample2/

Кстати

Правила перенаправления обязательны. Все запросы (кроме статических файлов) должны быть перенаправлены на index.php. Конфигурация Apache .htaccess выглядит следующим образом:

<IfModule mod_rewrite.c>
    RewriteEngine On
    #ignore if it's a file
    RewriteCond %{REQUEST_FILENAME} !-f
    #redirect all request to index.php
    RewriteRule .* index.php
</IfModule>

Вы также можете легко найти эквивалентные настройки для nginx, lighthttpd или других серверных фронтендов :)

Наконец

Найдите партнёра по фронтенду. Поскольку у меня ограниченные возможности во фронтенде, я прошу партнёра присоединиться.

Этот проект является исключительно личным хобби, цель которого — простота, гибкость и высокая настраиваемость.

Свяжитесь с QQ: 798047000.