Cómo agregar (y organizar) fácilmente documentación en su sitio web Divi

Publicado: 2017-05-23

¿Necesita agregar documentación a uno de sus sitios web Divi? La documentación le permite proporcionar todo tipo de información útil a sus lectores y clientes. Pero debido a que la documentación es su propio tipo de contenido, probablemente no desee mezclar el contenido de la documentación con publicaciones o páginas regulares de WordPress.

Entonces, para mostrarle cómo agregar documentación a WordPress (y, más específicamente, a una instalación de WordPress que ejecuta el tema Divi WordPress), le daré un tutorial rápido sobre cómo usar un nuevo complemento gratuito llamado DocuPress.

¿Qué es DocuPress y qué hace?

DocuPress es una herramienta gratuita para agregar documentación a cualquier sitio de WordPress. Está desarrollado por Robert DeVore y nació de la necesidad de Robert de una herramienta de documentación ligera para algunos de sus otros proyectos de desarrollo de WordPress.

Si bien hay muchas soluciones de base de conocimientos de servicio pesado para WordPress, DocuPress es útil si solo está buscando agregar documentación básica a su sitio. Es decir, si no necesita un montón de códigos cortos y análisis integrados.

Esto es lo que realmente hace DocuPress cuando lo instala:

  • Crea un nuevo tipo de publicación personalizada de Documentación
  • Agrega una nueva taxonomía personalizada de Colecciones para dividir su documentación en diferentes categorías.
  • Le brinda un widget que le permite mostrar fácilmente elementos de documentación en su barra lateral o en el contenido que crea con Divi Builder (u otras herramientas que le permiten mostrar widgets dentro de sus publicaciones).

En el futuro, Robert tiene planes de agregar algunos códigos cortos básicos para brindarle aún más flexibilidad.

Si desea ver DocuPress en acción, puede consultar un ejemplo del mundo real en la documentación del complemento WP Dispensary de Robert.

Debemos enfatizar que este complemento es nuevo. Si bien no está haciendo nada especialmente complejo, siempre debes tenerlo en cuenta antes de ir con todo de inmediato.

Cómo utilizar DocuPress para crear documentación

Ahora que sabe lo que hace, así es como puede usar DocuPress para crear documentación para su propio sitio de WordPress.

Paso 1: Instale y active DocuPress

DocuPress está disponible de forma gratuita en el repositorio de complementos de WordPress.org, por lo que puede instalarlo directamente desde su panel de WordPress.

documentación

Una vez instalado, no es necesario configurar nada. Recuerde: ¡esta es una solución liviana!

Paso 2: agregue sus colecciones de documentación

Una vez que active DocuPress, debería ver un nuevo tipo de publicación personalizada de Documentación . Pero antes de comenzar a agregar artículos de documentación, debe agregar algunas colecciones para categorizar sus artículos.

Para hacerlo, diríjase a Documentación → Colecciones . Complete los detalles y haga clic en Agregar nueva colección . Esto funciona de manera muy similar a una categoría para una publicación normal de WordPress:

agregar nueva colección

Agregue tantas colecciones como crea que necesita para dividir adecuadamente sus artículos de documentación.

Paso 3: agregue sus artículos de documentación

Una vez que tenga sus colecciones, diríjase a Documentación → Agregar nuevo para agregar artículos de documentación reales. Este es prácticamente el editor de WordPress normal, excepto con una adición clave.

Dale un título a tu artículo e ingresa el contenido de la publicación. Luego, seleccione su Colección como lo haría con una categoría para una publicación normal de WordPress.

Lo único nuevo que debe hacer es elegir Atributos del artículo → Orden en la parte inferior derecha. Esto define el orden en el que se muestran sus artículos en el widget. Por ejemplo:

  • 0 se muestra primero
  • 1 es el siguiente en la lista
  • Etcétera.

artículos de documentación

Luego, asegúrese de publicar su artículo.

Repita el proceso para todos los artículos de documentación que necesite.

Paso 4: Muestre sus colecciones de documentación

Una vez que haya agregado todas sus colecciones y artículos, estará listo para mostrarlos en la interfaz. Para hacer eso, puede usar el widget incluido para agregar listados de documentación a:

  • Tu barra lateral
  • Contenido que crea con Divi Builder (u otra herramienta que le permite usar widgets en su contenido)

La barra lateral es simple: solo diríjase a Apariencia → Widgets y arrastre sobre el widget Artículos de DocuPress :

widget de documentación

Tu puedes elegir:

  • El título que se muestra encima de la lista de artículos de documentación.
  • Cuántos artículos de documentación mostrar
  • Ya sea para mostrar todas las colecciones o una colección específica
  • Si aleatorizar o no el orden de los artículos

Si desea mostrar sus listados de documentación en su contenido en lugar de su barra lateral, puede usar el Módulo de barra lateral de Divi en su lugar.

Para hacer eso, comience agregando un nuevo widget en la parte inferior del área de Widgets:

agregar nuevo widget

Una vez que lo haga, tendrá una nueva área de la barra lateral de documentación a la que puede agregar el widget de DocuPress:

barra lateral de documentación

Si desea mostrar diferentes secciones, puede agregar varios widgets de DocuPress a esta barra lateral.

Luego, diríjase a Divi Builder para la página a la que desea agregar su documentación. Agregue un nuevo módulo de barra lateral y seleccione el área de documentación que acaba de crear:

configuración de la barra lateral

Luego, asumiendo que está utilizando el constructor visual , debería ver las categorías de su documentación:

categorías de documentación

Como todos los módulos Divi, también puede jugar con el estilo en la pestaña Diseño si desea, por ejemplo, cambiar el color y el tamaño de la fuente para los títulos de las categorías de documentación:

diseño del módulo divi

Y, por supuesto, puede agregar otros módulos Divi según sea necesario para darle vida a su página de documentación. Pero eso es todo lo que necesita hacer para agregar la funcionalidad de documentación principal.

Si necesita agregar su documentación a una página sin Divi Builder, también puede usar un complemento como Widget Shortcode para poder extraer el widget DocuPress a través de un shortcode.

Terminando

Con todo, DocuPress es una solución bastante simple para crear y administrar documentación en WordPress. No espere toneladas de campanas y silbidos, pero si solo quiere algo simple y liviano, es una buena opción.

Y aunque probablemente no te tomaría mucho tiempo crear algo similar para ti con tipos de publicaciones personalizadas, de esta manera no necesitas ensuciarte las manos.

Como mencioné, Robert tiene planes de agregar algunos códigos cortos integrados, por lo que el complemento pronto será aún más fácil de usar.

Ahora le toca a usted: ¿qué piensa sobre el uso de algo ligero como DocuPress para su documentación o la de su cliente? ¿Prefieres este enfoque a algunos de los complementos de documentación más resistentes que existen?

Imagen en miniatura del artículo por turali / shutterstock.com