Download the PHP package alexgh12/help_center without Composer
On this page you can find all versions of the php package alexgh12/help_center. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download alexgh12/help_center
More information about alexgh12/help_center
Files in alexgh12/help_center
Package help_center
Short Description Centro de ayuda, genera una pagina web para mostrar los articulos de ayuda y/o documentación, leyendo los archivos .md de la carpeta resources/docs
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 help_center
Introducción
Centro de ayuda para Laravel que genera una página web para mostrar artículos de ayuda y/o documentación, leyendo archivos .md desde la carpeta resources/docs.
Requisitos
- PHP 7.4+ u 8.0+
- Laravel 7.0+, 8.37+, 9.0+, 10.0+, 11.0+, 12.0+ o 13.0+
- Composer
Instalación
-
Ejecuta el siguiente comando en tu terminal:
-
El paquete se auto-registra gracias a Laravel Package Auto-Discovery. No necesitas agregar el Service Provider manualmente.
- (Opcional) Publica los archivos de configuración y documentación de ejemplo:
Configuración
Archivo de configuración
Después de publicar la configuración, puedes modificar config/HelpCenter.php:
Opciones disponibles
| Opción | Descripción | Valor por defecto |
|---|---|---|
enabled |
Activa o desactiva el centro de ayuda | true |
path_views |
Prefijo de la ruta URL para acceder al help center | help-center |
path_docs |
Ruta relativa a los archivos de documentación (.md) | resources/docs/ |
default_file |
Archivo markdown que se muestra por defecto | introduction.md |
auth |
Requiere autenticación para acceder | false |
Variables de entorno
Puedes configurar todas las opciones usando variables de entorno en tu archivo .env:
Publicar archivos
El paquete proporciona los siguientes tags de publicación:
Uso
Estructura de documentos
Crea archivos .md en la carpeta resources/docs/. La estructura de carpetas se refleja automáticamente en el menú lateral.
Ejemplo de estructura:
URL de acceso
Por defecto, el help center está disponible en /help-center.
Características de Markdown
El paquete soporta:
- Encabezados (h1-h6)
- Listas (ordenadas y desordenadas)
- Código con resaltado de sintaxis (usando Prism.js)
- Tablas
- Blockquotes
- Diagramas Mermaid
- Imágenes
- Links
Ejemplo de documento
Documentación de ejemplo
Después de ejecutar php artisan vendor:publish --tag=help-center-docs, tendrás la siguiente estructura de ejemplo:
Puedes usar estos archivos como punto de partida para tu documentación.
Licencia
AlexGh12 es software de código abierto bajo licencia MIT.
