ddliu/

airdoc

在空中提供文档

维护者

详细信息

github.com/ddliu/airdoc

源代码

问题

安装: 0

依赖项: 0

建议者: 0

安全: 0

星标: 1

关注者: 3

分支: 0

开放问题: 0

v0.1.0 2015-03-18 09:20 UTC

Requires

MIT fcda765719980b890f1710538960fbe6fc8b5653

  • dong <ddliuhb.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-13 22:04:01 UTC

README

在空中提供markdown文档。

Screenshot

特性

  • 文档按目录结构化
  • 多个来源
  • 无数据库

安装

使用Composer

composer require ddliu/airdoc

使用GIT

git clone https://github.com/ddliu/airdoc.git docviewer
cd docviewer
composer install

Web服务器

Nginx

参见nginx.conf

Apache

.htaccess已为Apache配置。

PHP内置服务器

make server

或

php -S localhost:8080 -t . router.php

配置

Airdoc可以通过config.php进行自定义。

<?php
return [
    'title' => 'Page title',
    // add multiple document sources
    'mount' => [
        'path/to/src2' => '/', // base source
        '../path/to/src1' => '/group1',
        'path/to/src3' => '/group1/group2',
    ],
    // basic auth
    'users' => [
        'user1' => 'password1',
        'user2' => 'password2',
        'user3' => 'password3',
    ],
    // path patterns to be ignored
    'ignore_regexp' => [
        '/\.', // ignore hidden files or directories(start with dot)
        '\.php$', // ignore php file
    ],
];
?>

待办事项

  • 目录
  • 缓存