Descripción

Local Docs es un visor local de documentación Markdown que detecta automáticamente el directorio de documentos y permite consultarlo desde el navegador.

¿Qué problema resuelve?

Permite consultar documentación Markdown de un proyecto local sin configurar un servidor externo ni mover los archivos a otra plataforma.

Features

• Detecta el directorio docs/ en la carpeta actual o en sus directorios padre.
• Renderiza archivos Markdown en un servidor local.
• Incluye búsqueda y un índice lateral para navegar la documentación.
• Abre automáticamente el navegador al iniciar.
• Permite configurar la ruta de documentación, el puerto y la interfaz de escucha.
• Incluye atajos de teclado para controlar la búsqueda, el índice y el contenido.

Cómo usar

npx @mane087/local-docs

Busca un directorio docs/ en el directorio actual y, si no lo encuentra, en sus directorios padre. Levanta un servidor en http://127.0.0.1:4180 y abre el navegador.

Requisitos

Node.js 20.19 o superior.

Opciones

--dir <ruta>    Fuerza la raíz de documentación
--port <n>      Puerto preferido (por omisión 4180)
--host <host>   Interfaz de escucha (por omisión 127.0.0.1)
--no-open       No abre el navegador
--version       Muestra la versión
--help          Muestra la ayuda

Atajos de teclado

| Tecla | Efecto | | -------------- | ------------------------------------------- | | Cmd/Ctrl + K | Abrir la busqueda | | I | Mostrar u ocultar el indice lateral | | C | Mostrar u ocultar el contenido de la pagina |

Las teclas sueltas se ignoran mientras escribes en un campo de texto y cuando llevan una tecla modificadora, para no pisar los atajos del navegador ni los del sistema. Funcionan igual en Windows, Linux y macOS.

Instalación local

Para instalar y ejecutar el proyecto desde el código fuente:

npm install
npm run build
npm start

El comando start inicia el servidor usando la documentación del directorio actual o la que se encuentre en sus directorios padre.