Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cambio a pandoc #3

Merged
merged 27 commits into from
Jan 29, 2022
Merged

Cambio a pandoc #3

merged 27 commits into from
Jan 29, 2022

Conversation

Asmilex
Copy link
Owner

@Asmilex Asmilex commented Jan 28, 2022

Exceptuando unos cuantos archivos de ./applications, que se encuentran a medio hacer, este PR cambia lo siguiente:

De LaTeX a Pandoc

Markdown, en general, es mucho más sencillo de escribir. La conveniencia es el factor más importante de este cambio. Además, con la plantilla de Eisvogel se puede producir un libro elegante de forma fácil.

La estructura es la siguiente:

  • Archivos *.md de la carpeta docs/headers: contiene la información de la plantilla, así como los parámetros de Pandoc.
  • Los capítulos se encuentran en docs/chapters, así como la bibliografía.
  • Las dependencias se de la documentación se hallan en docs/headers.

Los cambios hechos en la documentación se han marcado con [📓]. De momento, únicamente se encuentran archivos de lorem-ipsum.

Finalmente, se ha configurado VSCode para proporcionar la mejor experiencia. Tiene diccionarios para ayudar a la corrección, así como autocompilación del HTML.

Habemus web

Accede a https://asmilex.github.io/TFG_RT_VkRay/ para comprobar la documentación actualizada 🎉.

Se ha construido utilizando Pandoc, bamboo.css y Prism.js. El syntax hightlighting es un tema modificado de Batman Mono.

Limpieza general del README

Antes, se usaba como log y como lugar donde poner la bibliografía y otros recursos. Eso, se elimina, y se pasa a Github Projects.

@Asmilex Asmilex added the documentation Improvements or additions to documentation label Jan 28, 2022
@github-pages github-pages bot temporarily deployed to github-pages January 29, 2022 16:23 Inactive
@github-pages github-pages bot temporarily deployed to github-pages January 29, 2022 18:51 Inactive
@github-pages github-pages bot temporarily deployed to github-pages January 29, 2022 19:07 Inactive
@github-pages github-pages bot temporarily deployed to github-pages January 29, 2022 19:17 Inactive
Se tarda mucho en construir el PDF (aprox. 17s), mientras que `index.html` tarda muy poco en compilarse. Por ello, parece más conveniente automatizar la versión web.
@github-pages github-pages bot temporarily deployed to github-pages January 29, 2022 19:30 Inactive
@Asmilex Asmilex merged commit 046b508 into main Jan 29, 2022
@Asmilex Asmilex deleted the Cambio-a-pandoc branch January 29, 2022 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant