Cómo ver la documentación del código sin conexión con Zeal

Si ha escrito algún código, probablemente esté de acuerdo en que programar implica leer documentación, mucha. En muchos casos, el tiempo dedicado a leer documentación y otro código excede el tiempo real de escritura de código. Y dado que la mayoría de las veces se accede a esa documentación en la Web, se pierde una parte importante de tiempo para encontrar la información que está buscando y esperar a que se cargue. Estos pequeños retrasos pueden ser frustrantes, especialmente con conexiones más lentas, y pueden sumarse rápidamente a minutos u horas de pérdida de productividad. Además, se requiere una conexión constante a Internet, que no siempre está disponible, para acceder a esa información,

Afortunadamente, puede usar Zeal, un navegador de documentación fuera de línea, para almacenar el lenguaje de programación y la documentación del software en su computadora y acceder a él de manera rápida y efectiva. Zeal utiliza conjuntos de documentos (docsets) proporcionados por Pizca. Incluyen documentación para muchos lenguajes y bibliotecas de programación y scripting, así como varios software como Docker, Nginx, WordPress y ElasticSearch, por nombrar algunos.

Aquí se explica cómo instalar, usar y personalizar Zeal en Linux.

Instalación de Zeal

Zeal está disponible en los repositorios de software de muchas distribuciones de Linux, por lo que debería instalarlo usando su administrador de paquetes nativo si es posible.

En Ubuntu, Linux Mint y Debian:

sudo apt install zeal

En Arch Linux:

sudo pacman -S zeal

En Gentoo:

sudo emerge app-doc/zeal

En Fedora:

sudo dnf install zeal

Usando Zeal

Puede iniciar Zeal desde el menú / lanzador de su aplicación o desde una terminal de línea de comandos escribiendo zeal.

Zeal no incluye ninguna documentación por defecto. Para ver los conjuntos de documentos disponibles, vaya a «Herramientas -> Conjuntos de documentos» y abra la pestaña «Disponibles».

Seleccione los conjuntos de documentos que desea almacenar y haga clic en «Descargar». Una vez recuperados, los conjuntos de documentos se muestran en el panel superior izquierdo en una estructura jerárquica navegable. Cuando corresponde, el panel inferior izquierdo muestra accesos directos a los elementos de la página del documento actual.

Puede buscar todos los conjuntos de documentos introduciendo una consulta o un conjunto de documentos específico con la sintaxis docset:query. Por ejemplo, para buscar Python re.match función, entrarías python:re.match.

Nota: con la sintaxis de búsqueda compuesta (es decir docset:query), los docset parte distingue entre mayúsculas y minúsculas, y la query parte no distingue entre mayúsculas y minúsculas.

Personalización de Zeal

Fuentes

Puede configurar la apariencia de Zeal a su gusto con fuentes y tamaños de fuente.

Para hacerlo, vaya a «Editar -> Preferencias -> Contenido» y luego seleccione una familia de fuentes predeterminada y fuentes específicas para cada familia de fuentes.

Modo oscuro

Zeal también proporciona un modo oscuro (en «Editar -> Preferencias -> Contenido»), aunque solo se aplica al contenido del documento y no a la interfaz gráfica circundante, como puede ver en la siguiente captura de pantalla.

CSS definido por el usuario

Si va a usar Zeal de forma regular, entonces vale la pena dedicar algo de tiempo para ajustarlo a su gusto. Puede utilizar una hoja de estilo personalizada para tener un control mayor y más preciso sobre la apariencia de los documentos.

Crea un nuevo archivo CSS usando tu editor de texto:

vim ~/.local/share/Zeal/custom.css

Ingrese los conjuntos de reglas CSS deseados, por ejemplo:

code {
border-style: dashed;
border-width: 1px;
color: red;
}

Vaya al archivo «Editar -> Preferencias -> Contenido -> CSS personalizado» para seleccionar el archivo CSS recién creado. Después de guardar su configuración, los cambios serán visibles inmediatamente. La siguiente captura de pantalla muestra Zeal después de aplicar el CSS anterior.

Conclusión

Zeal es una gran herramienta para programadores y administradores de sistemas que tienden a acceder a la documentación con frecuencia. Dado que almacena documentos localmente, puede ahorrarle tiempo y permitirle concentrarse mejor en el trabajo que tiene entre manos. Además, a diferencia de los documentos web, admite hojas de estilo definidas por el usuario para un control preciso de la apariencia del documento.