laravel-docweaver | Product documentation generation package for Laravel

by reliqarts PHP Version: v5.0.0 License: MIT

X-Ray Key Features Code Snippets(3)Community Discussions Vulnerabilities Install Support

kandi X-RAY | laravel-docweaver Summary

laravel-docweaver is a PHP library. laravel-docweaver has no bugs, it has no vulnerabilities, it has a Permissive License and it has low support. You can download it from GitHub.

An easy-to-use product documentation package for Laravel. Docweaver 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.

Support

Quality

Security

License

Reuse

Support

laravel-docweaver has a low active ecosystem.

It has 36 star(s) with 3 fork(s). There are 3 watchers for this library.

It had no major release in the last 12 months.

laravel-docweaver has no issues reported. There are no pull requests.

It has a neutral sentiment in the developer community.

The latest version of laravel-docweaver is v5.0.0

Quality

laravel-docweaver has 0 bugs and 0 code smells.

Security

laravel-docweaver has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

laravel-docweaver code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

laravel-docweaver is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

laravel-docweaver releases are available to install and integrate.

Installation instructions, examples and code snippets are available.

laravel-docweaver saves you 2016 person hours of effort in developing the same functionality from scratch.

It has 4481 lines of code, 269 functions and 81 files.

It has medium code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi has reviewed laravel-docweaver and discovered the below as its top functions. This is intended to give you an instant insight into laravel-docweaver implemented functionality, and help decide if they suit your requirements.

Deletes a directory .
Publish documentation command
Create a new Process instance .
Creates an exception for a directory .
Set the message .
Get real path .
Get the contents of a file .
Parse YAML .

Get all kandi verified functions for this library.

laravel-docweaver Key Features

No Key Features are available at this moment for laravel-docweaver.

laravel-docweaver Examples and Code Snippets

Laravel Docweaver,Installation & Usage,Documentation Directory

PHP

Lines of Code : 10

License : Permissive (MIT)

Copy

[doc dir]
    │
    └─── Project One
    │       └── 1.0 
    │       └── 2.1
    │            └── .docweaver.yml       # meta file (optional)
    │            └── documentation.md     # sidebar nav
    │            └── installation.md      # initial

Laravel Docweaver,Installation & Usage,Installation

PHP

Lines of Code : 10

License : Permissive (MIT)

Copy

composer require reliqarts/laravel-docweaver

{
    "require": {
        "reliqarts/laravel-docweaver": "^2.0"
    }
}

ReliqArts\Docweaver\ServiceProvider::class,

php artisan storage:link

php artisan vendor:publish --provider="ReliqArts\Docweaver\

Laravel Docweaver,Installation & Usage,Setup

PHP

Lines of Code : 2

License : Permissive (MIT)

Copy

DOCWEAVER_ROUTE_PREFIX=docs
DOCWEAVER_DIR=resources/docs

Community Discussions

No Community Discussions are available at this moment for laravel-docweaver.Refer to stack overflow page for discussions.

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install laravel-docweaver

Install via composer; in console:.
Set the desired environment variables so the package knows your image model, controller(s), etc. These variables, and more are explained within the config file.

Support

The 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. Each 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.

Find more information at: