О проекте

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

Под лицензией MIT.

Автор

• 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 и задайте для книг массив, подобный этому:

[
    {
        "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_en, китайскую версию через xx_sdk_wiki_cn... Даже версия по умолчанию установлена на китайский язык, поэтому вы можете посетить 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

Спасибо!

В этом проекте я добавил две книги, как я уже говорил.

Для sample1 перейдите по адресу http://115.159.31.66/tiny_wiki/.

Для sample2 перейдите по адресу http://115.159.31.66/tiny_wiki/sample2/.

Кстати

Правила перенаправления необходимы. Файл 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 или других, просто погуглив :)