Hacktoberfest

El Hacktoberfest ya está aquí y tú también puedes participar a la vez que ayudas a mantener actualizada la traducción de la documentación de Laravel.

Cómo participar

El proceso es muy sencillo:

  1. Regístrate en la página del Hacktoberfest con tu cuenta de GitHub
  2. Dirígete al repositorio de la documentación, selecciona uno de los issues de archivos por actualizar, deja un comentario dentro del issue para evitar que otros usuarios trabajen en el mismo archivo. También puedes enviar correcciones libres de errores ortográficos o cualquier otro problema que notes en el texto de la documentación.
  3. Agrega las actualizaciones, crea un Pull Request y ¡Listo! Luego de haber creado cuatro Pull Requests y que estos hayan sido aceptados en este y/o otros repositorios Open Source participarás automáticamente en el evento Hacktoberfest .

Formato

La traducción de la documentación de Laravel 6.0, está publicada usando VuePress y disponible en GitHub para que cualquier persona, incluyéndote, pueda colaborar a mantenerla actualizada y mejorarla. En este post documentaré cómo realizar estas contribuciones y la sintaxis a tener en cuenta para mantener todo en orden.

Sintaxis de Markdown y VuePress

La documentación oficial de Laravel usa Markdown y la traducción de la documentación también, sin embargo, dado que usamos VuePress para publicar el sitio de la traducción, la sintaxis difiere un poco de la usada en el repositorio oficial.

Bloques de código

En la documentación oficial de Laravel los bloques de código aparecen usando sólo una tabulación, de esta forma:

Esto es debido a que el interprete de Markdown de la documentación oficial reconoce dicha tabulación e interpreta que el texto ubicado ahí es un bloque de código. Sin embargo, en VuePress esto es un poco diferente. Debemos envolver el bloque de código con tres backticks ` seguido del nombre del lenguaje cuya sintaxis queremos resaltar y eliminar la tabulación (ya que si no la removemos, el bloque será mostrado con doble tabulación):

Tips

En la documentación oficial de Laravel los tips aparecen con la sintaxis > {tip} seguido del contenido del tipo. En VuePress debemos mostrar esto de forma diferente, envolviendo el contenido del tip con la sintaxis especial ::: tip de la siguiente manera:

Ten en cuenta que debes colocar el texto TIP en mayúsculas para que sea mostrado así al momento de compilar el Markdown a HTML.

Notas

Las notas tanto en la documentación oficial de Laravel como en la traducción son mostradas de forma similar a los tips:

Se utiliza ::: danger debido a que VuePress no cuenta con una sintaxis específica para notas y el tema fue modificado para usar ::: danger en esos casos.

Blade

Al usar sintaxis del sistema de plantillas Blade debemos envolver las expresiones usando ::: v-pre y backticks para indicar a VuePress que el contenido es código para ser mostrado y no para ser interpretado por Vue al momento de compilar el HTML del sitio:

Observa como envolvemos el párrafo usando ::: v-pre y la expresión de Blade usando backticks.

Listas

En la documentación oficial de Laravel las listas vienen envueltas en una etiqueta <div> de la siguiente forma:

En VuePress debemos remover las etiquetas <div> que envuelven el contenido y dejar simplemente los elementos de la lista, de la siguiente forma:

Configuración del sitio

La configuración del sitio puede ser encontrada en el directorio docs/.vuepress/ del repositorio de GitHub de la traducción. Si encuentras algún error, ya sea en los enlaces del menú superior o lateral, puedes realizar un PR modificando el archivo config.js.

Para agregar elementos al menú, simplemente busca la sección del sidebar en donde quieres agregar el elemento y agrega un nuevo arreglo con la URL de destino y el texto a mostrar en el enlace:

Material Relacionado

Suscríbete a nuestro boletín

Te enviaremos publicaciones con consejos útiles y múltiples recursos para que sigas aprendiendo.

Regístrate hoy en Styde y obtén acceso a todo nuestro contenido.