{"id":20121436,"url":"https://github.com/reliqarts/laravel-docweaver","last_synced_at":"2025-05-06T15:30:57.087Z","repository":{"id":34306075,"uuid":"105720440","full_name":"reliqarts/laravel-docweaver","owner":"reliqarts","description":"Product documentation generation package for Laravel.","archived":false,"fork":false,"pushed_at":"2024-03-04T01:49:52.000Z","size":804,"stargazers_count":44,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-09T14:04:49.482Z","etag":null,"topics":["documentation","generator","laravel","laravel-5-package","laravel-6-package","laravel-docweaver","markdown","organizer","product","readme"],"latest_commit_sha":null,"homepage":"http://docweaver.reliqarts.com","language":"PHP","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/reliqarts.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":"reliq"}},"created_at":"2017-10-04T01:18:26.000Z","updated_at":"2025-03-23T16:35:56.000Z","dependencies_parsed_at":"2024-03-04T02:44:34.865Z","dependency_job_id":"e44204f6-0469-429d-8c74-06952ee0b2ba","html_url":"https://github.com/reliqarts/laravel-docweaver","commit_stats":{"total_commits":135,"total_committers":4,"mean_commits":33.75,"dds":"0.22962962962962963","last_synced_commit":"2d40427bf1a8348887d0acfe4d393fe84163f740"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reliqarts%2Flaravel-docweaver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reliqarts%2Flaravel-docweaver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reliqarts%2Flaravel-docweaver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reliqarts%2Flaravel-docweaver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reliqarts","download_url":"https://codeload.github.com/reliqarts/laravel-docweaver/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252712839,"owners_count":21792379,"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":["documentation","generator","laravel","laravel-5-package","laravel-6-package","laravel-docweaver","markdown","organizer","product","readme"],"created_at":"2024-11-13T19:29:06.263Z","updated_at":"2025-05-06T15:30:56.739Z","avatar_url":"https://github.com/reliqarts.png","language":"PHP","funding_links":["https://github.com/sponsors/reliq"],"categories":[],"sub_categories":[],"readme":"# Laravel Docweaver\n\nAn easy-to-use product documentation package for Laravel. \n\nDocweaver is suitable for product documentation and/or knowledge bases. Converts folder(s) of .md files into full-bread complete documentation. Docweaver is inspired by Laravel's very own documentation.\n\n[![Built For Laravel](https://img.shields.io/badge/built%20for-laravel-red.svg?style=flat-square)](http://laravel.com)\n[![Build Status (all)](https://img.shields.io/travis/com/reliqarts/laravel-docweaver?style=flat-square)](https://travis-ci.com/reliqarts/laravel-docweaver)\n[![Scrutinizer](https://img.shields.io/scrutinizer/g/reliqarts/laravel-docweaver.svg?style=flat-square)](https://scrutinizer-ci.com/g/reliqarts/laravel-docweaver/)\n[![Codecov](https://img.shields.io/codecov/c/github/reliqarts/laravel-docweaver.svg?style=flat-square)](https://codecov.io/gh/reliqarts/laravel-docweaver)\n[![Maintainability](https://api.codeclimate.com/v1/badges/9c4ff316977eba7256c6/maintainability)](https://codeclimate.com/github/reliqarts/laravel-docweaver/maintainability)\n[![License](https://poser.pugx.org/reliqarts/laravel-docweaver/license?format=flat-square)](https://packagist.org/packages/reliqarts/laravel-docweaver)\n[![Latest Stable Version](https://poser.pugx.org/reliqarts/laravel-docweaver/version?format=flat-square)](https://packagist.org/packages/reliqarts/laravel-docweaver)\n[![Latest Unstable Version](https://poser.pugx.org/reliqarts/laravel-docweaver/v/unstable?format=flat-square)](//packagist.org/packages/reliqarts/laravel-docweaver)\n[![check it out!](https://img.shields.io/badge/read-the%20docs-blue.svg?style=flat-square)](http://docweaver.reliqarts.com) \n\n\u0026nbsp;\n\n## Key Features\n\nDocweaver provides the following features and more out of the box.\n\n- Multi-product support\n    - Docweaver supports multiple products out-the-box. Just create your product folders and drop in your documentation version directories.\n- Plug and play\n    - Just install and configure and you're golden! *(approx. 2min)*\n\n## Installation \u0026 Usage\n\n### Installation\n\nInstall via composer; in console: \n```\ncomposer require reliqarts/laravel-docweaver\n``` \nor require in *composer.json*:\n```json\n{\n    \"require\": {\n        \"reliqarts/laravel-docweaver\": \"^2.0\"\n    }\n}\n```\nthen run `composer update` in your terminal to pull it in.\n\nOnce this has finished, you will need to add the service provider to the providers array in your app.php config as follows:\n*(n.b. This package supports Laravel's package auto-discovery; if you are using Laravel 5.5 or above you can skip this step.)*\n\n```php\nReliqArts\\Docweaver\\ServiceProvider::class,\n```\n\nEnsure that your applications public storage directory is linked and accessible via the browser.\n\n```bash \nphp artisan storage:link\n```\nsee: https://laravel.com/docs/master/filesystem\n\nFinally, publish package resources and configuration:\n\n```\nphp artisan vendor:publish --provider=\"ReliqArts\\Docweaver\\ServiceProvider\"\n``` \n\nYou may opt to publish only configuration by using the `docweaver-config` tag:\n\n```\nphp artisan vendor:publish --provider=\"ReliqArts\\Docweaver\\ServiceProvider\" --tag=\"docweaver-config\"\n```\n\n### Setup\n\nSet the desired environment variables so the package knows your image model, controller(s), etc. \n\nExample environment config:\n```\nDOCWEAVER_ROUTE_PREFIX=docs\nDOCWEAVER_DIR=resources/docs\n```\n\nThese variables, and more are explained within the [config](https://github.com/ReliqArts/laravel-docweaver/blob/main/src/config/config.php) file.\n\n### Documentation Directory\n\nThe documentation directory is the place where you put your project documentation directories. It may be changed with the config key `docweaver.storage.dir` or the environment variable `DOCWEAVER_DIR`. The default documentation directory is `resources/docs`.\n\n#### Structure\n\nEach project directory should contain separate folders for each documented version. Each version must have at least two (2) markdown files, namely `documentation.md` and `installation.md`, which serve as the sidebar and initial documentation pages respectively.\n\n```\n[doc dir]\n    │\n    └─── Project One\n    │       └── 1.0 \n    │       └── 2.1\n    │            └── .docweaver.yml       # meta file (optional)\n    │            └── documentation.md     # sidebar nav\n    │            └── installation.md      # initial page\n    │\n    └─── Project Two\n```\n\n#### Meta File\n\nConfigurations for each doc version may be placed in `.docweaver.yml`. The supported settings are:\n- #### name\n    Product name.\n- #### description\n    Product description.\n\n- #### image_url\n    Product image url. This may be an absolute url (e.g. `http://mywebsite.com/myimage.jpg`) or an image found in the `images` resource directory.\n\n    To use the `foo.jpg` in the images directory you would set `image_url` to `{{docs}}/images/foo.jpg`.\n\n    For more info. see: [Assets](/docs/{{version}}/assets)\n\n----\n\n### Acknowledgements\n\nThis package was inspired by Laravel's [documentation](https://github.com/laravel/laravel) and uses its underlying mechanism as a base.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freliqarts%2Flaravel-docweaver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freliqarts%2Flaravel-docweaver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freliqarts%2Flaravel-docweaver/lists"}