sinri/ark-static-docs

A static documentation library project with Ark Web

0.2.7 2021-07-05 07:55 UTC

Requires

• erusev/parsedown: ~1.7.4
• sinri/ark: ~3.4

MIT

• Sinri Edogawa

README

composer require sinri/ark-static-docs

Ark Static Docs is a simple OOTB library project to support documentation.

Usage

First, prepare the documents in Markdown format and put them into one directory; Subdirectories are allowed, but in each subdirectory an index.md is needed. The file system name would be turned to readable title follow a simple rule: underline (_) becomes space( );

// If you give an array of ArkRequestFilter
$filters=[];
// The directory path where documents store
$docRootPath='/path/to/docs';
(new sinri\ark\StaticDocs\ArkStaticDocsService(Ark()->webService(),'/path/to/docs'))
    ->install($filters)
    // If the ArkWebService instance is shared, install is enough;
    // If this service is running independently, you may run it as a swift way. 
    ->run();

Other Information

Page Rendering Reference

We use erusev/parsedown (version 1.7.4) for Markdown Rendering.

We use github-markdown-css (version 4.0.0) for HTML Style.

<link rel='stylesheet' href='https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/4.0.0/github-markdown.min.css'
      integrity='sha512-Oy18vBnbSJkXTndr2n6lDMO5NN31UljR8e/ICzVPrGpSud4Gkckb8yUpqhKuUNoE+o9gAb4O/rAxxw1ojyUVzg=='
      crossorigin='anonymous'/>

Server Config Reference (Related: Ark-Web)

If you use Apache to load the project, you need to add the .htaccess file and open the allow override option.

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php [QSA,L]

For Nginx, you should use try_files.

server {
    location / {
        try_files $uri $uri/ /index.php$is_args$args;
    }
}