Jam3 Api Doc
Generate the API documentation and create the custom page theme to show it
by Guillermo Figueroa Mesa · github.com/gfirem/api_documentor · website
Install
No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:
wp plugin install https://github.com/gfirem/api_documentor/archive/refs/heads/master.zipReadme
WORK IN PROGRESS
Introduccion
La idea es crear un plugin que integre el sistema de generar la documentacion para las api con wordpress. Esto nos da la ventaja de crear una pagina y seleccionar como plantilla la que adiciona el plugins y tendriamos toda la documentacion del plugin lista para consumir.
Como funciona.
El plugins adiciona un nuevo tipo de plantilla. Si la seleccionamos se carga con las vistas que estan dentro del plugin y se muestra el proyecto generado dentro del plugin.
Este plugin no genera la documentacion de la API solo expone el la documentacion generada por el plugin #### que tiene que estar instalado y configurado para que genere la documentacion dentro de la carpeta project dentro del plugin
Cosas por hacer
- Hay que resolver la ruta base de donde se carga las cosas. Esto esta en main.js dentro de la plantilla de jam3
- Hay que mejorar el comando para
- Hacer que lea la documentacion desde otra ubicacion dentro del sitio. Hacer que lea desde afuera seria un problema de seguridad.