Download the PHP package rex-devs/lara-docs-kit without Composer
On this page you can find all versions of the php package rex-devs/lara-docs-kit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rex-devs/lara-docs-kit
More information about rex-devs/lara-docs-kit
Files in rex-devs/lara-docs-kit
Package lara-docs-kit
Short Description A Laravel documentation package, that adds the ability to add multiple documentation sections to an existing site, while also choosing custom urls for each.
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 lara-docs-kit
Lara Docs Kit
Welcome to lara-docs-kit, a powerful Laravel documentation package. This package aims to simplify the process of creating and managing documentation for your Laravel projects.
Installation
To get started with lara-docs-kit, follow these simple steps:
-
Install the package via Composer:
-
Publish the tailwind css file.
-
To enable the syntax highlighting the javascript package shiki is needed to be installed in the project. It can be install via npm:
-
A directory to store all the markdown files for the documentation will need to be created, using the default config the following command can be used to create the directory.
-
A
nav.jsonfile will then be needed within that directory outlining the navigation menu. - That's it! You're now ready to start using lara-docs-kit for your Laravel documentation needs.
Usage
The package is configured to run straight out the box, it adds a /docs route
that takes markdown files directly out of the /resources/docs directory and
deliveries them to the public. However, there is a config file that can be
published and changed as needed.
Configuration
To publish the configuration file using the following command:
The configuration file located at config/lara-docs-kit.php can then be
customised according to your project's requirements. Here is an example of a
route.
Navigation
The package also uses a nav.json file in the top level of the directory that
holds all the markdown files. This file allows for both top level links but also
nested links (maximum of 1 level deep).
Contributing
If you find any issues or have suggestions to improve lara-docs-kit, we welcome contributions from the community. Please feel free to submit a pull request or open an issue.
License
lara-docs-kit is open-source software licensed under the MIT license.
We hope lara-docs-kit proves to be a valuable tool for your Laravel projects. Should you have any questions or need assistance, don't hesitate to reach out to us on [email protected].
Happy documenting! 😊
All versions of lara-docs-kit with dependencies
spatie/yaml-front-matter Version ^2.0
spatie/laravel-markdown Version ^2.3