2012-04-27 10 views
7

Estoy en el proceso de agregar páginas github a algunos de mis repositorios y a mi página de usuario. Para muchas de las páginas web, quiero usar el formato de Markdown.no se puede encontrar documentación detallada y específica para utilizar el descuento en el proyecto github y las páginas de usuario

Sin embargo, como solo puedo encontrar vague, undetailed información acerca de cómo hacer esto, estoy haciendo un proceso de prueba y error para descubrir cómo funciona.

¿Dónde está la documentación real? ¿Los detalles sangrientos?


Here es la mejor información que he encontrado hasta ahora, que dice:

  • utilice el nombre de la rama especial gh-pages para crear un sitio para un proyecto de recompra
  • una de tres líneas encantamiento en la parte superior del archivo es necesario:

    --- 
    title: something 
    --- 
    
  • el sufijo se cambia a .html

Pero me quedo con muchas preguntas acerca de los detalles, tales como:

  • puedo importar archivos css?
  • ¿qué hace ese "título" en realidad?
  • ¿qué sufijo necesitan los archivos?

etc. Así que realmente me gustaría ver la documentación detallada de todas las funciones.


Tenga en cuenta que esta pregunta no es acerca de cómo utilizar la sintaxis de rebajas, pero la forma de aprovechar la magia de GitHub para la creación automática de HTML a partir de rebajas en el ámbito de las páginas de usuario y de proyectos.

Respuesta

4

cómo aprovechar la magia de GitHub para la creación automática de HTML a partir de rebajas en el ámbito de las páginas de usuario y de proyectos

Suena como que está hablando Jekyll.


¿Qué que "título" propaganda realmente?

El title es parte de YAML Front Matter. Se trata básicamente de una variable que pueda access través page.title


Lo sufijo qué los archivos necesita tener?

Siempre que el archivo tenga una sección de materia prima YAML, será transformado por Jekyll.Lo mismo ocurrirá con cualquier archivo .html, .markdown, .md o .textile en el directorio raíz de su sitio o en directorios que no se encuentran en la lista anterior.

github.com/mojombo/jekyll/wiki/usage

0

Sólo los archivos con extensiones .md o .markdown serán traducidos a HTML en una página de usuario GitHub.

archivos con extensiones .html y .textile son no traducida, de acuerdo con mis intentos.

Tenga en cuenta que se debe evitar la codificación UTF8.

+0

¿Por qué se debe evitar UTF8? –

+0

@MattFenwick: menciona que está cerca de la parte superior de la página de YAML Front Matter: https://github.com/mojombo/jekyll/wiki/YAML-Front-Matter. –

Cuestiones relacionadas