PHPackages                             sinri/ark-static-docs - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. sinri/ark-static-docs

ActiveLibrary

sinri/ark-static-docs
=====================

A static documentation library project with Ark Web

0.2.7(4y ago)040MITPHP

Since Apr 16Pushed 4y ago1 watchersCompare

[ Source](https://github.com/sinri/Ark-StaticDocs)[ Packagist](https://packagist.org/packages/sinri/ark-static-docs)[ RSS](/packages/sinri-ark-static-docs/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (9)Dependencies (2)Versions (10)Used By (0)

Ark Static Docs
===============

[](#ark-static-docs)

[![Packagist Version](https://camo.githubusercontent.com/5fff619b4c14dc12de3a1999460f15be9c9115ba6d1635e7b4d7ed9e86899985/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73696e72692f61726b2d7374617469632d646f6373)](https://camo.githubusercontent.com/5fff619b4c14dc12de3a1999460f15be9c9115ba6d1635e7b4d7ed9e86899985/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73696e72692f61726b2d7374617469632d646f6373)

`composer require sinri/ark-static-docs`

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

Usage
-----

[](#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
-----------------

[](#other-information)

### Page Rendering Reference

[](#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.

```

```

### Server Config Reference (Related: Ark-Web)

[](#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;
    }
}
```

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~10 days

Recently: every ~20 days

Total

9

Last Release

1778d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/5821330?v=4)[Everstray Jun Sinri Edogawa](/maintainers/sinri)[@sinri](https://github.com/sinri)

---

Top Contributors

[![sinri](https://avatars.githubusercontent.com/u/5821330?v=4)](https://github.com/sinri "sinri (18 commits)")

### Embed Badge

![Health badge](/badges/sinri-ark-static-docs/health.svg)

```
[![Health](https://phpackages.com/badges/sinri-ark-static-docs/health.svg)](https://phpackages.com/packages/sinri-ark-static-docs)
```

###  Alternatives

[afragen/github-updater

A plugin to automatically update GitHub, Bitbucket, GitLab, or Gitea hosted plugins, themes, and language packs.

3.3k20.4k](/packages/afragen-github-updater)[kimai/kimai

Kimai - Time Tracking

4.6k7.4k1](/packages/kimai-kimai)[afragen/git-updater

A plugin to automatically update GitHub, Bitbucket, GitLab, or Gitea hosted plugins, themes, and language packs.

3.3k1.6k](/packages/afragen-git-updater)[pods-framework/pods

Pods is a development framework for creating, extending, managing, and deploying customized content types in WordPress.

1.1k1.7k](/packages/pods-framework-pods)[sitegeist/fluid-styleguide

Living styleguide for Fluid Components

16227.4k1](/packages/sitegeist-fluid-styleguide)[benjaminhoegh/parsedown-extended

An extension for Parsedown.

5022.6k1](/packages/benjaminhoegh-parsedown-extended)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)