Download the PHP package hyvor/laradocs without Composer
On this page you can find all versions of the php package hyvor/laradocs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hyvor/laradocs
More information about hyvor/laradocs
Files in hyvor/laradocs
Package laradocs
Short Description Small libray from laravel projects to generate documentation quickly
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laradocs
Laradocs
Fully customizable, small libray for laravel projects to generate documentation quickly.
Installation
Use the composer to install Doc generator to your laravel project.
Usage
After installation you need to publish it's assets and configurations file using following commands to make it customizable. You can define multiple documentation by using several arrays in config. Each array represents seperate configurations for specific documentation of your application.
The route key in the configuration file is the subdomain given by Laradocs to the documentation. You cannot use your application without that subdomain route key.
The theme key defines your theme css file name. Default theme file is theme.css.
Your content files path can be set in config.php at content_directory as base path of your application. Default path is docs.
navigation key in config is an array which defines the design of navigation in your documentation. There is a section array inside navigation array. The section seperates the links of your navigation panel.
Inside a section, there are multiple arrays for navigation links with each link comprised three keys. They are id, file, label
idis required, it defines the path for the link and content file.fileis optional, specify the path for content file if it is different from defaultidvaluelableis also required which establish title of the page and navigation menu lable
Publish assets to public folder (* Required)
Asset file publication is required to make them accessible for laradocs.
Publish configuration files (* Required)
Config file publish to your application directory is required. You must define its required fields to make your laradocs plugin work.
Publish view files (Optional)
You only need to publish views to your application directory if you want to customize default structure of views.
How to create your own theme for documentation
There is an option provided in laradocs to create your own design for the documentation. You have to define path to your view files using the view value in config. There are several important dynamic variables returns from laradocs backend as displayed in table bellow.
| Variable Name | Data Type | Description |
|---|---|---|
$content |
mixed | Returns the content of the page |
$pageName |
string | Returns the id value of page link |
$label |
string | Returns the label value of page link |
$route |
string | Returns the route name of the page |
$nav |
array | Returns navigation array of documentation |
Inside config file
You can change this file values according to your requirement.
License
The MIT License (MIT). Please see License File for more information.
