Skip to content
This repository has been archived by the owner on Mar 17, 2021. It is now read-only.

Latest commit

 

History

History
226 lines (143 loc) · 10.9 KB

README-es.adoc

File metadata and controls

226 lines (143 loc) · 10.9 KB

HubPress

¿Qué es HubPress?

editor

HubPress es una herramienta de código abierto, que puedes usar para construir un enriquecido blog basado en AsciiDoc y utilizando GitHub Pages!

Creado y mantenimo por Anthonny Quérouil (twitter @anthonny_q).

Note
Aunque HubPress parezca tener todas las funcionalidades, esta actualmente en vista preliminar. Los errores son inevitables, por eso si encuentras que algo no se esta comportando de la manera que piensas deberia hacerlo, notifica el error y el equipo del proyecto se dirigirá a él tan pronto como sea posible.

La documentación esta evolucionando rápidamente en la medida que el proyecto va creciendo. Visita regularmente para obtener más consejos sobre como usar HubPress. Si encuentras algún error en la documentación, por favor notifica el error. Tu ayuda en la mejora de todos los aspectos de HubPress es muy apreciada, Los Pull Request siempre son bienvenidos.

Compatibilidad con Navegadores

HubPress es compatible con Chrome para escritorio, Firefox para escritorio y Chrome para Android.

Chrome Beta para Android será completamente compatible pronto, pero no esta completamente soportada por algunos errores en IndexedDB, por eso durante la vista preliminar usa unicamente Chrome para Android.

Introducción

Instalación

Hacer fork al repositorio

Has Click en el icono de Fork Fork para crear una copia de este repositorio con tu cuenta de GitHub.

Usa el dominio github.io

Si nunca has usado el dominio de GitHub Pages, puedes usar este procedimiento para rápidamente instalar HubPress. Con este método, se requieren solo algunos pasos para tener Hubpress instalado y listo para usar.

Important
Si actualmente estas usando tu usuario.github.io de GitHub Pages para otro proyecto, o si deseas usar un dominio personalizado, salta a las siguientes instrucciones.
  1. Cambia el nombre del repositorio a <usuario>.github.io

  2. Configura los valores iniciales en hubpress/config.json

    Edit config

    Los siguientes parámetros son obligatorios :

    • username, que es su nombre de usuario de GitHub,

    • repositoryName, que es el nuevo nombre del Fork del repositorio, <usuario>.github.io.

  3. Confirma los cambios, e ingrese al dominio de GitHub Pages: http://<usuario>.github.io/.

  4. La siguiente pantalla indica que has configurado correctamente HubPress.

    Install complete

Usar un dominio personalizado ó si su dominio de GitHub Page esta actualmente en uso

Si deseas tener tu blog disponible en un dominio personalizado , o si ya estas usando tu dominio de GitHub Pages para otro proyecto, necesitas una configuración adicional.

  1. En la configuración del Repositorio, establece la rama por defecto a gh-pages :

    Settings gh-pages

  2. cambia tu repositorio a la rama gh-pages

    Install complete

  3. establece los valores requeridos en `hubpress/config.json

    Edit config

    Los siguientes parámetros son obligatorios :

    • username, el cual es tu nombre de usuario de GitHub,

    • repositoryName, el cual es tu copia del repositorio. Por ejemplo, hubpress.io si no lo has renombrado.

  4. Confirma los cambios, y accesa a tu dominio de Github Pages: http://<username>.github.io/<repositoryName>/.

  5. La siguiente pantalla indica que has configurado correctamente HubPress

    Install complete

Consola de Administración

La Consola de Administración esta disponible en /hubpress

Ingresar a la Consola de Administración

Install complete

Ingresa tus credenciales de Github para iniciar sesión en la Consola Administrativa de HubPress.

Una vez autenticado, es generado un Token para futuras llamadas de Hubpress al API de GitHub.

Esto se sincroniza en todas las sesiones de HubPress, por lo que si se abre la consola de administración en su PC y luego su Tablet, el token es aplicable a todos los dispositivos.

Página de Configuración

Puedes configurar los ajustes básicos del Blog (tales como CNAME y paginación) y cuentas de medios sociales que desees conectar a tu blog.

Meta

Esta sección contiene información básica configurada en el archivo /hubpress/config.json.

Los siguientes campos son configurables:

Git CNAME

Le permite especificar un nombre de dominio personalizado. Ver Setting Up A Custom Domain para obtener instrucciones sobre cómo configurar un CNAME para tu blog.

Live Preview Render Delay

Controla cuanto tiempo tarda el renderizador en vivo para refrescar, en milisegundos. Para mecanógrafos rápidos, establece el campo en un valor superior a 2000 (dos segundos) esto dará lugar a una experiencia de edición más suave porque la vista previa no se regenerará con tanta frecuencia. Establecer este valor por debajo de 2000 dará lugar a la generación de la vista previa más rapido, pero puede dar lugar a cierto retraso del cursor al escribir.

Sitio

Titulo y Descripción

Los campos Title y Description te permiten colocar un nombre a tu blog, y una breve descripción para que tus visitantes puedan conocer que esperar de tus entradas en el blog.

Los campos Logo y Cover Image pueden ser usados de las siguientes maneras:

  • Un enlace HTML a un servicio de hosting de imagenes, pro ejemplo Gravatar.

  • Un enlace a una imagen almacenada en el directorio /images del repositorio de tu blog.

Note
Revisa el archivo /images/README.adoc para algunas opciones de como incluir imagenes es tus entradas del blog.
Temas

El campo Theme es seleccionable de una lista de temas almacenados en el directorio /themes. El nombre debe ser especificamente el mismo que posee el directorio que contiene el tema.

Google Analytics

El Campo Google Analytics toma el código único de Google Analytics generado para el sitio.

Nombre Corto Disqus

El campo Disqus shortname toma tu Disqus URL/nombrecorto que especificas cuando registras un nuevo sitio para Disqus. Solo el nombre corto es requerido, no el enlace a tu perfil personal.

Redes Sociales

Todos los campos en este grupo requieren el URLs completo a tu pagina de perfil publico. La manera en que estos valores son renderizados en tu blog depende en el tema seleccionado.

Manajando entradas

Cuando inicies con HubPress, la vista Posts esta vacia. A medida que crees tus entradas en el blog, la pagina irá creciendo con la lista de entradas a tu izquierda, y una vista previa de la entrada en si a la derecha.

Creando una Entrada

Note
Si nunca has usado AsciiDoc para escribir contenido, la guía para Escritores de AsciiDoctor debe ser tu primera parada en tu viaje. La guía te provee de ejemplos de marcas básicos y avanzados para copiar y usar.

El editor de HubPress muestra el código de AsciiDoc a la izquierda, y la vista previa en la derecha.

Titulo del blog y encabezamiento

El titulo del blog siempre estará de primer nivel en la entrada en AsciiDoc. Por ejemplo, = Titulo del Blog establece el nombre de la entrada del blog a Titulo del Blog.

Una linea = Titulo del Blog es requerida para guardar satisfactoriamente la entrada.

Si quieres colocar un encabezado de primer nivel debes utilizar == Encabezado de Primer Nivel, y de esta manera crear los encabezados anidados consecutivamente.

Parámetros de HubPress

HubPress le permite modificar las características de cada entrada del blog mediante atributos.

:hp-image: para Imagen de Portada de la Entrada del Blog

Si quieres agregar una imagen de portada a tu entrada del blog, debes agregar el atributo hp-image.

  1. :hp-image: Por Ejemplo:

= Blog Title
:hp-image: a-cover-image.jpg

NOTA: Debido a los valores predeterminados en HubPress el directorio /images funciona como la raíz de todas las imágenes, sólo tiene que declarar el nombre del archivo de la imagen. Debido a esto, es posible que desee considerar la creación de un directorio /covers en su repositorio para agrupar las imágenes de las portadas juntas. Nombrar las imágenes de la cubierta consistentemente hará que sea muy fácil de aplicar a cada entrada. Si usted tiene un tema para su blog, esto permite a sus lectores obtener una idea visual de lo que trata la entrada.

Los temas que actualmente soportan imagenes de portadas en las entradas del blog son:

  • Saga

:published_at: Para alterar la Fecha de Publicación

Por defecto, la fecha de publicación es la fecha de creación de la entrada en el blog. puedes forzar la fecha de publicación añadiendo el atributo published_at.

  1. :published_at: Por Ejemplo :

= Blog Title
:published_at: 2015-01-31

:hp-tags: Etiquetas

Note
Categorias no son soportadas.

Añadir etiquetas mediante el atributo hp-tags.

  1. :hp-tags: Por Ejemplo:

= Blog Title
:hp-tags: HubPress, Blog, Open Source,

:hp-alt-title: Para Especificar un Título Alternativo

Especifique un título alternativo mediante el atributo hp-alt-title.

El título alternativa se utiliza en lugar del nombre de archivo HTML generado por HubPress.

  1. :hp-alt-title: Por Ejemplo :

= 大千世界
:hp-alt-title: My English Title

Solución de problemas

Si algo no está funcionando como esperas, algunos de estos consejos podrían ayudarte.

Restablecimiento de la Base de datos del Blog en Android

A veces, la base de datos local de HubPress pierde la sincronía con tu blog publicado. Esto puede suceder debido a que estás editando tu blog en tu PC, y luego cambias a la tableta.

HubPress trabaja en una base de datos almacenada localmente específica en tu navegador, por lo que si cambia de dispositivo - y luego cambia navegadores - se pierde la sincronía entre los navegadores.

Para devolver la instancia de HubPress a la de el blog publicado, borrar la caché del navegador y de datos en Ajustes > Aplicaciones. Al hacer esto, HubPress se ve obligado a reconstruir la base de datos local, y reflejará el estado del blog en GitHub.

Créditos

Gracias a Jared Morgan para inicialmente poner en orden el archivo README que se ve aquí, y seguir siendo el "Documentador" para HubPress. Gracias a takkyuuplayer, hinaloe por haber traducido el README en Japones.