Knowledge-Graphs-Book / HTML-Book

Other
36 stars 7 forks source link

Setup workflow files for compiling the book automatically. #41

Closed miselico closed 1 year ago

miselico commented 1 year ago

As discussed in #36 it would be nice to host the book on github pages. This pull request enables this. Some further setup is still needed, though.

What is still needed (I did these on my own repo, I can do it here as well):

What this does:

  1. Whenever a change is made to the main branch, a process starts which compiles the index.html file and deploys it together with the other resources (now fixed to css fonts images js bib). This would then become immediately visible on kgbook.org .
  2. When working on something, you should work in a branch. When a push to a branch occurs, a process is started which compiles the index.html file and places it together with the other resources (now fixed to css fonts images js bib) into another repository.

    1. That repository is also hosted, but under a different URL or path, and hence it is possible to preview the changes.
    2. Once we are happy with the changes, open a pull request, merge that in and rule 1 above kicks in to deploy on the webpage.