pages how docs deploy github doxygen github-pages

how - github pages docs folder



¿Puedo tener mi index.html de Github Pages en una subcarpeta del repositorio? (6)

Ahora tiene la opción de usar la carpeta /docs de la rama master como la raíz de su sitio web de github.

Estoy tratando de usar las páginas de Github para alojar un sitio de Doxygen. Idealmente, me gustaría poder enviar los archivos y directorios generados a Github sin tener que modificarlos en absoluto. Esto, sin embargo, significa que mi index.html está en una subcarpeta del repositorio y Github Pages no lo recoge (me sale un 404 cuando intento acceder al sitio de Pages). ¿Hay alguna forma de hacer que Github reconozca ese index.html cuando está en una subcarpeta? Es un sitio de proyecto.


Cree un index.html ficticio en la raíz y ponga esto en su encabezado:

<meta http-equiv="refresh" content="0; url=http://repo.github.io/folder/index.html" />

Asegúrese de cambiar la URL de destino. Esto redirigirá instantáneamente de index.html a su carpeta / index.html.


Para usar Doxygen y gh-pages , necesitas:

  1. Crea el archivo .nojekyll en la raíz de tu rama de gh-pages
  2. Asegúrese de haber eliminado .png , .html y similares de su archivo .gitignore
  3. Crea el index.html , también en la raíz de tu proyecto:

    <!DOCTYPE HTML> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="refresh" content="1;url=html/index.html"> <title>Page Redirection</title> </head> <body> If you are not redirected automatically, follow the <a href="html/index.html">link to the documentation</a> </body> </html>

Referencias:

  1. GitHub Pages (github.io) No se encontró la página generada por doxygen (404)
  2. Cómo generar automáticamente la documentación de doxygen usando Travis
  3. Implementación automática de la documentación de Doxygen en las páginas gh con Travis CI
  4. https://help.github.com/categories/github-pages-basics/
  5. Publique su documentación de proyecto con GitHub Pages
  6. Cómo hacer una página de introducción con Doxygen.

Respuesta de David Jacquel es impresionante.

Pero si está tratando de servir todo su blog personal de SPA desde /dist o /build folder de github pages como lo hago yo, hay un hermoso truco sucio de Raphael Pedicini: https://github.com/rafrex/spa-github-pages

Él sugiere que cree una página proxy index.html y una página personalizada 404.html . Si su usuario ingresa la url directa de una subpágina, por ejemplo, https://example.github.io/blog/ , el servidor de github pages servirá 404.html con scripts que pasarán la url como un conjunto de parámetros a un proxy index.html, que lanza SPA.

No duplicaría su código aquí, ya que muy bien podría cambiar con el tiempo.


Tal vez lo que quieres es empujar un subárbol. Por ejemplo, digamos que tiene el directorio build/dist y allí se construye el sitio de Doxygen.

Después de construir, asegúrese de confirmar todos los cambios en esa carpeta y haga lo siguiente.

git subtree push --prefix build/dist origin gh-pages

Es importante que no tengas nada en la rama de gh-pages , local o de origen.

todo el crédito a: https://gist.github.com/cobyism/4730490

Inicialmente también pensé en una redirección. Pero las redirecciones se sienten como olores de código, incluso las redirecciones de http. Aunque a veces es inevitable, aquí puede haber una solución más limpia, probablemente lo que estaba buscando.


intente transferir su archivo index.html y todas sus dependencias a un nuevo repositorio y luego use ese repositorio como un submódulo en su repositorio actual. Actualmente, github-pages espera encontrar un archivo index.html en la raíz de su repositorio que no puede.

p.ej. digamos que su repositorio actual es ''prueba''. Usted crea un nuevo informe, "sitio web", transfiere su .html y otros archivos que son necesarios para el repositorio de "sitio web". Ahora necesita usar el repositorio ''website'' como un submódulo dentro del repositorio de ''prueba''.

nota: en el esquema anterior solo necesita usar el nombre de la rama ''gh-pages'' en el repositorio de su ''sitio web'' mientras que la ''prueba'' aún puede conservar la rama maestra.

Pequeño tutorial de ejemplo sobre submódulos de git.