{"id":50345370,"url":"https://github.com/mykemeynell/inkstone","last_synced_at":"2026-05-29T20:00:27.229Z","repository":{"id":361229001,"uuid":"1253711217","full_name":"mykemeynell/inkstone","owner":"mykemeynell","description":"Generate static documentation sites from Markdown for Laravel projects and standalone PHP package repositories","archived":false,"fork":false,"pushed_at":"2026-05-29T18:41:26.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-29T19:09:17.564Z","etag":null,"topics":["composer-library","docs-generator","docs-site","documentation","documentation-generator","laravel","markdown","markdown-documentation","standalone-php-library","static-documentation","static-documentation-generator"],"latest_commit_sha":null,"homepage":"https://mykemeynell.github.io/inkstone/","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/mykemeynell.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-29T18:32:55.000Z","updated_at":"2026-05-29T19:08:12.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mykemeynell/inkstone","commit_stats":null,"previous_names":["mykemeynell/inkstone"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/mykemeynell/inkstone","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mykemeynell%2Finkstone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mykemeynell%2Finkstone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mykemeynell%2Finkstone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mykemeynell%2Finkstone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mykemeynell","download_url":"https://codeload.github.com/mykemeynell/inkstone/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mykemeynell%2Finkstone/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33668186,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-29T02:00:06.066Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["composer-library","docs-generator","docs-site","documentation","documentation-generator","laravel","markdown","markdown-documentation","standalone-php-library","static-documentation","static-documentation-generator"],"created_at":"2026-05-29T20:00:15.575Z","updated_at":"2026-05-29T20:00:27.218Z","avatar_url":"https://github.com/mykemeynell.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Inkstone\n\nInkstone generates static documentation sites from Markdown for Laravel projects and standalone PHP package repositories.\n\n## Install\n\n```bash\ncomposer require mykemeynell/inkstone --dev\n```\n\n## Standalone Usage\n\nUse the package binary when the target project is not a full Laravel application:\n\n```bash\nvendor/bin/inkstone docs:build --source=docs --output=build/docs\n```\n\nUseful options:\n\n- `--source=docs` sets the Markdown source directory.\n- `--output=build/docs` sets the generated static site directory.\n- `--base-url=/docs` sets the base URL when the generated site is mounted below a subdirectory.\n- `--config=inkstone.php` loads an optional PHP config file and merges it over the defaults.\n\nYou can generate docs for another package by running the command from that package root, or by passing absolute paths:\n\n```bash\nvendor/bin/inkstone docs:build \\\n  --source=/path/to/package/docs \\\n  --output=/path/to/package/build/docs\n```\n\n## Laravel Usage\n\nInside a Laravel application, use the Artisan commands registered by the service provider:\n\n```bash\nphp artisan docs:install\nphp artisan docs:build\nphp artisan docs:serve\nphp artisan docs:clean\n```\n\n`docs:install` publishes Inkstone configuration, starter docs, theme assets, and deployment examples. `docs:build` writes deployable static HTML into `build/docs` by default.\n\nInkstone also ships optional Laravel Boost resources:\n\n```text\nresources/boost/guidelines/core.blade.php\nresources/boost/skills/inkstone-documentation/SKILL.md\n```\n\nIf your Laravel app uses Boost, run `php artisan boost:install` or `php artisan boost:update` after installing Inkstone so Boost can include the Inkstone guidance and documentation skill. Boost is not required for standalone or Artisan builds.\n\n## Configuration\n\nInkstone uses `config/inkstone.php` inside Laravel applications. In standalone package repositories, create `inkstone.php` or `config/inkstone.php` in the package root.\n\n```php\n\u003c?php\n\nreturn [\n    'docs_path' =\u003e __DIR__.'/docs',\n    'output_path' =\u003e __DIR__.'/build/docs',\n    'site' =\u003e [\n        'title' =\u003e 'Package Documentation',\n        'base_url' =\u003e '',\n    ],\n    'github' =\u003e [\n        'repository' =\u003e 'https://github.com/vendor/package',\n        'branch' =\u003e 'main',\n    ],\n];\n```\n\n## Build Output\n\nGenerated sites use pretty URLs:\n\n```text\nbuild/docs/index.html\nbuild/docs/installation/index.html\nbuild/docs/search-index.json\n```\n\nThe output can be deployed to GitHub Pages, Cloudflare Pages, Netlify, Vercel, or any static host.\n\nBy default, generated links and assets assume `build/docs` is served as the web root. Set `DOCS_BASE_URL` or pass `--base-url` only when the site is mounted below a subdirectory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmykemeynell%2Finkstone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmykemeynell%2Finkstone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmykemeynell%2Finkstone/lists"}