{"id":20433950,"url":"https://github.com/cable8mm/document2","last_synced_at":"2026-03-07T07:32:09.676Z","repository":{"id":229834130,"uuid":"777756061","full_name":"cable8mm/document2","owner":"cable8mm","description":"The Document2 is to generate Laravel style documents to static website","archived":false,"fork":false,"pushed_at":"2024-04-12T12:12:40.000Z","size":3030,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-08T14:51:14.281Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cable8mm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2024-03-26T13:01:29.000Z","updated_at":"2024-03-27T12:49:08.000Z","dependencies_parsed_at":"2024-04-12T03:25:15.005Z","dependency_job_id":"1745f8ce-a5fe-4d09-b76f-7f43ac461765","html_url":"https://github.com/cable8mm/document2","commit_stats":null,"previous_names":["cable8mm/document2"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/cable8mm/document2","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cable8mm%2Fdocument2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cable8mm%2Fdocument2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cable8mm%2Fdocument2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cable8mm%2Fdocument2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cable8mm","download_url":"https://codeload.github.com/cable8mm/document2/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cable8mm%2Fdocument2/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30209727,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T05:23:27.321Z","status":"ssl_error","status_checked_at":"2026-03-07T05:00:17.256Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-11-15T08:22:52.289Z","updated_at":"2026-03-07T07:32:09.632Z","avatar_url":"https://github.com/cable8mm.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Document2 - Documentation Generator\n\n[![code-style](https://github.com/cable8mm/document2/actions/workflows/code-style.yml/badge.svg)](https://github.com/cable8mm/document2/actions/workflows/code-style.yml)\n[![run-tests](https://github.com/cable8mm/document2/actions/workflows/run-tests.yml/badge.svg)](https://github.com/cable8mm/document2/actions/workflows/run-tests.yml)\n[![Packagist Version](https://img.shields.io/packagist/v/cable8mm/document2)](https://packagist.org/packages/cable8mm/document2)\n[![Packagist Downloads](https://img.shields.io/packagist/dt/cable8mm/document2)](https://packagist.org/packages/cable8mm/document2/stats)\n[![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/cable8mm/document2/php)](https://packagist.org/packages/cable8mm/document2)\n![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/cable8mm/document2/laravel-zero%2Fframework)\n[![Packagist Stars](https://img.shields.io/packagist/stars/cable8mm/document2)](https://github.com/cable8mm/document2/stargazers)\n[![Packagist License](https://img.shields.io/packagist/l/cable8mm/document2)](https://github.com/cable8mm/document2/blob/main/LICENSE.md)\n\nThe Document2 is to generate Laravel style documents to static website.\n\nWe have done our best to create a convenient tool for you all. Take a moment to see how it works.\n\n## Features\n\n- [x] Generate static website from documentations\n- [x] Versions are supported\n- [x] Templates are supported\n- [x] Testing available locally\n- [x] Dark theme is supported\n- [ ] Skeleton Theme is supported\n- [ ] Search is supported\n- [ ] Publish GitHub Pages with actions\n- [ ] SEO is supported\n\n## Installation\n\n```shell\ncomposer install cable8mm/document2\n```\n\n## Usage\n\nThree official three templates are available. We can introduce them for creating as soon as possible.\n\nSelect your template:\n\n```shell\nbin/install-theme.sh https://github.com/cable8mm/laravel-theme\n```\n\nAnd clone the documentation files:\n\n```shell\nbin/checkout_latest_docs.sh\n# Import laravel documentations into `docs` folder\n```\n\nFinally, run the following command to generate the static htmls\n\n```shell\n./document2\n# Generate the static html files into the `public` folder\n\n./document2 -d docs -b 10.x -f artisan.md\n# Generate the static html file of directory `docs`, branch `10.x` and filename `artisan.md`\n```\n\nIf Laravel Valet or Laravel Herd has been installed, you can visit https://document2.test.\n\n## Development Templates\n\n### Create\n\n```shell\ncd templates\n\nnpm run dev\n```\n\nand visit http://localhost:5173/. The port can be different.\n\n### Reserved Placeholders\n\n    {{ section_title }} : replaces the section title\n    {{ title }} : replaces the title\n    {{ version }} : replaces the documentation version\n    {{ canonical }} : replaces the canonical url of the documentation\n    {{ app_url }} : replaces the documentation url\n    {{ original_url }} : replaces the original website url out of docs\n\n### Reserved Dividers\n\n    \u003c!-- doc.navigator.start --\u003e\n    The navigator html is inserted in this area\n    \u003c!-- doc.navigator.end --\u003e\n\n    \u003c!-- version.options.start --\u003e\n    The option html is inserted in this area\n    \u003c!-- version.options.end --\u003e\n\n    \u003c!-- doc.content.start --\u003e\n    The markdown documentation html is inserted in this area\n    \u003c!-- doc.content.end --\u003e\n\n## Testing\n\n```shell\ncomposer test\n```\n\n## Formatting\n\n```shell\ncomposer lint\n# Modify all files to comply with the PSR-12.\n\ncomposer inspect\n# Inspect all files to ensure compliance with PSR-12.\n```\n\n## License\n\nThe Document2 project is open-sourced software licensed under the [MIT license](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcable8mm%2Fdocument2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcable8mm%2Fdocument2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcable8mm%2Fdocument2/lists"}