{"id":22152356,"url":"https://github.com/sinri/ark-staticdocs","last_synced_at":"2025-06-20T23:07:13.439Z","repository":{"id":57051746,"uuid":"358211294","full_name":"sinri/Ark-StaticDocs","owner":"sinri","description":null,"archived":false,"fork":false,"pushed_at":"2021-07-05T07:57:42.000Z","size":45,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-20T23:06:17.565Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sinri.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-15T10:02:12.000Z","updated_at":"2021-07-05T07:56:04.000Z","dependencies_parsed_at":"2022-08-24T03:41:09.452Z","dependency_job_id":null,"html_url":"https://github.com/sinri/Ark-StaticDocs","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/sinri/Ark-StaticDocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinri%2FArk-StaticDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinri%2FArk-StaticDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinri%2FArk-StaticDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinri%2FArk-StaticDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sinri","download_url":"https://codeload.github.com/sinri/Ark-StaticDocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinri%2FArk-StaticDocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261032072,"owners_count":23100049,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-02T00:50:37.997Z","updated_at":"2025-06-20T23:07:08.421Z","avatar_url":"https://github.com/sinri.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ark Static Docs\n\n![Packagist Version](https://img.shields.io/packagist/v/sinri/ark-static-docs)\n\n`composer require sinri/ark-static-docs`\n\n`Ark Static Docs` is a simple OOTB library project to support documentation.\n\n## Usage\n\nFirst, prepare the documents in Markdown format and put them into one directory; Subdirectories are allowed, but in each\nsubdirectory an `index.md` is needed. The file system name would be turned to readable title follow a simple rule:\nunderline (`_`) becomes space(` `);\n\n```php\n// If you give an array of ArkRequestFilter\n$filters=[];\n// The directory path where documents store\n$docRootPath='/path/to/docs';\n(new sinri\\ark\\StaticDocs\\ArkStaticDocsService(Ark()-\u003ewebService(),'/path/to/docs'))\n    -\u003einstall($filters)\n    // If the ArkWebService instance is shared, install is enough;\n    // If this service is running independently, you may run it as a swift way. \n    -\u003erun();\n\n```\n\n## Other Information\n\n### Page Rendering Reference\n\nWe use `erusev/parsedown` (version 1.7.4) for Markdown Rendering.\n\nWe use `github-markdown-css` (version 4.0.0) for HTML Style.\n\n```html\n\n\u003clink rel='stylesheet' href='https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/4.0.0/github-markdown.min.css'\n      integrity='sha512-Oy18vBnbSJkXTndr2n6lDMO5NN31UljR8e/ICzVPrGpSud4Gkckb8yUpqhKuUNoE+o9gAb4O/rAxxw1ojyUVzg=='\n      crossorigin='anonymous'/\u003e\n```\n\n### Server Config Reference (Related: Ark-Web)\n\nIf you use Apache to load the project, you need to add the .htaccess file and open the `allow override` option.\n\n```apacheconf\nRewriteEngine On\nRewriteCond %{REQUEST_FILENAME} !-f\nRewriteCond %{REQUEST_FILENAME} !-d\nRewriteRule ^(.*)$ index.php [QSA,L]\n```\n\nFor Nginx, you should use try_files.\n\n```nginxconf\nserver {\n    location / {\n        try_files $uri $uri/ /index.php$is_args$args;\n    }\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinri%2Fark-staticdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsinri%2Fark-staticdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinri%2Fark-staticdocs/lists"}