Editar en GitHub

Cómo escribir un artículo de blog

Comité Técnico de Express
Comité Técnico de Express

Si tienes una idea para un artículo del blog, sigue estos pasos para proponerla y potencialmente conseguir que se publique.

  1. Propose your post

    Antes de tomarte el tiempo de escribir un artículo, por favor confirma que podremos publicarlo. Buscamos temas específicamente relacionados con Express, por lo que queremos pre-aprobar todos los artículos. Por ahora, esto significa que no aceptamos artículos no solicitados. Para proponer un artículo, abre un issue titulado Propuesta de artículo: <tu idea>.

  2. Fork the repository

    Si el TC de Express acepta tu propuesta, empieza a escribir tu artículo haciendo un fork del repositorio expressjs.com y clonándolo en tu máquina local. Una vez que abras un pull request, podrás previsualizar tu artículo en GitHub. Ver el paso seis más abajo.

Opcional: Para ejecutar el sitio localmente y previsualizar tu artículo antes de abrir un PR, consulta las instrucciones de configuración en el README.

  1. Create a new file

    Crea un nuevo archivo en el directorio src/content/blog nombrado siguiendo el formato: YYYY-MM-DD-title.md. El prefijo de fecha se usa como fecha de publicación a menos que establezcas un campo date en el front matter (ver más abajo).

  2. Add the required front matter

    Copia el siguiente front matter, incluyendo las líneas de puntos, y pégalo al principio del archivo que acabas de crear. Sustituye los valores placeholder por los que desees.

    ---
    title: <your-title>
    description: <description-of-your-post>
    date: YYYY-MM-DD
    tags: ['tag1', 'tag2']
    authors:
      - name: <your-name>
        github: <github-username>
    cover: <optional-cover-image-path>
    ---

    La propiedad github de un autor es opcional. Incluir solo tu nombre de usuario (no la URL completa de tu perfil) asegurará que tu artículo enlaze a él.

    La propiedad date es opcional. Cuando se establece, determina la fecha de publicación del artículo (usada para ordenamiento, visualización y feeds); de lo contrario se usa el prefijo YYYY-MM-DD en el nombre del archivo.

    La propiedad cover es opcional. Si se omite, se generará automáticamente una imagen Open Graph a partir del título del artículo. Si quieres una imagen de portada personalizada, colócala en el directorio public y referencia su ruta (ej. /images/my-cover.jpg).

  3. Add your content

    Finalmente, empieza a escribir tu contenido debajo del front matter. Usa formato markdown estándar.

    Using components (MDX)

    Si necesitas usar componentes interactivos como alertas, callouts, u otros elementos de UI dentro de tu artículo, renombra tu archivo de .md a .mdx. MDX te permite importar y usar componentes de Astro directamente en tu markdown.

    Por ejemplo, para añadir una alerta:

    ---
    title: My blog post
    description: A post with alerts
    tags: ['security']
    authors:
      - name: John Doe
        github: johndoe
    ---
    

    import Alert from '@components/primitives/Alert/Alert.astro';
    

    This is regular markdown content.
    

    <Alert type="warning">
      We strongly recommend upgrading to the latest version as soon as possible.
    </Alert>
    

    <Alert type="info">This feature is available starting from Express 5.0.</Alert>
    

    <Alert type="alert">
      This is a breaking change. Please review the migration guide before upgrading.
    </Alert>

    Los tipos de alerta disponibles son info, warning, y alert.

  4. Open a pull request (PR)

    Una vez que abras un PR, podrás previsualizar tus resultados: Habrá una sección en la página titulada Deploy Preview for expressjscom-preview ready! Haz clic en el enlace para ver el sitio renderizado desde tu fork/branch.

    Puedes usar esta función a lo largo de múltiples commits para refinar tu artículo haciendo un pull request en modo draft. Una vez que esté listo para revisión, cámbialo a un PR formal.

Más de Express