Publishing Quarto Website on Gitlab pages

[anaelDelorme]

I would like to publish a quarto site on gitlab pages. I found the doc for github (which works very well, thanks) but not for Gitlab.
Is it possible to do it ? Do you have recommendations or a guide?
Thank you.

[cderv]

I don't think we have yet a template for Quarto project rendered on Gitlab CI to use gitlab pages. This is definitely something we can add to our documentation.

However, yes it is definitely possible to do it and maybe there is already example around the web.

I see two ways:

• Use quarto to render locally your website and commit the outputs. Then use Gitlab CI with Gitlab pages to only deploy the content of the output directory. Only requirement I believe is for the output directory to be called public for Gitlab pages to work.
• Use Gitlab CI to build your website using Quarto and then deploy. Same requirement on the output folder name, but you'll also need to setup Gitlab CI with any computation environment required. Example: for R user, using gitlab ci with docker images for rocker project seems the easiest like this image https://hub.docker.com/r/rocker/verse.

I'll try to add one demo repository soon.

If you already try something, please share and I'll probably be able to help.

[sbalci]

I use gitlab pages with quarto over github actions.

in _quarto.yml add

  output-dir: public

consider adding resources as well:

project:
  type: website
  resources:
    - "css/"
    - "js/"
    - "*.html"`

add a file named .gitlab-ci.yml to main repo

# This file is a template, and might need editing before it works on your project.
# To contribute improvements to CI/CD templates, please follow the Development guide at:
# https://docs.gitlab.com/ee/development/cicd/templates.html
# This specific template is located at:
# https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Pages/HTML.gitlab-ci.yml

# Full project: https://gitlab.com/pages/plain-html
pages:
  stage: deploy
  script:
    - echo "start"
  artifacts:
    paths:
      - public
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

if you want to use github and mirror to gitlab use this action

  quarto-build-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Install Quarto
        uses: quarto-dev/quarto-actions/install-quarto@v1
      - name: Render website
        run: |
          quarto render


  build-togitlab:
    needs: quarto-build-deploy
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Mirror + trigger CI
      uses: SvanBoxel/gitlab-mirror-and-ci-action@master
      with:
        args: "https://gitlab.com/ name / repo"
      env:
        GITLAB_HOSTNAME: "gitlab.com"
        GITLAB_USERNAME: ""
        GITLAB_PASSWORD: ${{ secrets.GITLAB_PASSWORD }} # // Generate here: https://gitlab.com/profile/personal_access_tokens
        GITLAB_PROJECT_ID: "" # // https://gitlab.com/<namespace>/<repository>/edit
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # // https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret

[cderv]

Awesome ! Thanks for sharing. We should be able to update our documentation, or make a working demo repo from there.

[anaelDelorme]

Thanks a lot, it will be very useful !!!

[sbalci]

See a working example here:
Github Action:
https://github.com/patolojiatlasi/patolojiatlasi.github.io/blob/main/.github/workflows/Quarto-Render-Bilingual-Book-Push-Tweet-Updates.yml

GitLab Repo:
https://gitlab.com/patolojiatlasi/tr/

GitLab Page:
https://patolojiatlasi.gitlab.io/tr/

[Matherion]

This is a GitLab CI configuration for when you don't want to work from GitHub, but do everything on GitLab (in case anybody else finds this thread and is interested):
https://gitlab.com/health-psychology/hpss/-/blob/27b66c388f3ab24a7eb4ad8b2ec2c2cf952302a0/.gitlab-ci.yml

[sbalci]

If you are using knitr engine you may use tinytex package: https://yihui.org/tinytex/

[cderv]

With a TeX Live installation, Quarto will attempt to auto install missing dependency found during rendering. This is specific behavior, and inspired by what was done in R with tinytex R package.

TinyTeX LaTeX distribution is made available to quarto user to be installed with quarto install tool tinytex. This will be a TeX Live installation, and tlmgr should be available in PATH. So you could use tlmgr install manually if you want.

No need to involves knitr in all this, or even use the tinytex R package with Quarto.

xelatex: error while loading shared libraries: libfontconfig.so.1: cannot open shared object file: No such file or directory

This seems to point to a missing system lib. So probably installing libfontconfig package on the Linux environment could help with that. Or another one having the correct .so file.

[jpmorr]

@cderv the libfontconfig was one being thrown by ubuntu. After a while ubuntu stopped working with quarto:

$ git clone https://github.com/quarto-dev/quarto-cli
Cloning into 'quarto-cli'...
fatal: unable to access 'https://github.com/quarto-dev/quarto-cli/': server certificate verification failed. CAfile: none CRLfile: none
Cleaning up project directory and file based variables
00:01
ERROR: Job failed: exit code 1

So I've swapped to using almalinux now, which seems OK with quarto.

I tried tlmgr install hyphenat graphicx wallpaper geometry afterpage tikz pagecolor with TinyTex but the packages couldn't be found, not sure why:

tlmgr install: package afterpage not present in repository.
tlmgr install: package graphicx not present in repository.
tlmgr install: package tikz not present in repository.
tlmgr: package repository https://mirror.math.princeton.edu/pub/CTAN/systems/texlive/tlnet (verified)
tlmgr install: package already present: geometry
tlmgr install: package already present: hyphenat
tlmgr install: package already present: wallpaper
[1/1, ??:??/??:??] install: pagecolor [4k]
tlmgr: action install returned an error; continuing.
running mktexlsr ...
done running mktexlsr.
tlmgr: An error has occurred. See above messages. Exiting.
tlmgr: package log updated: /root/.TinyTeX/texmf-var/web2c/tlmgr.log
tlmgr: command log updated: /root/.TinyTeX/texmf-var/web2c/tlmgr-commands.log
Cleaning up project directory and file based variables
00:01
ERROR: Job failed: exit code 1

I've no idea why tlmgr is failing here.

[cderv]

Where did you get the list of the package to install ?

afterpage is not a package you can installed. It is part of tools.

Try

> tlmgr search --file --global "afterpage"
tlmgr.pl: package repository https://ctan.math.illinois.edu/systems/texlive/tlnet/ (verified)
latex-tools-dev:
        texmf-dist/doc/latex-dev/tools/afterpage.pdf
        texmf-dist/tex/latex-dev/tools/afterpage.sty
        texmf-dist/source/latex-dev/tools/afterpage.dtx
        texmf-dist/source/latex-dev/tools/afterpage.ins
lwarp:
        texmf-dist/tex/latex/lwarp/lwarp-afterpage.sty
tex-virtual-academy-pl:
        texmf-dist/doc/generic/tex-virtual-academy-pl/latex2e/macro/afterpage.html
tex4ht:
        texmf-dist/tex/generic/tex4ht/afterpage.4ht
tools:
        texmf-dist/doc/latex/tools/afterpage.pdf
        texmf-dist/tex/latex/tools/afterpage.sty
        texmf-dist/source/latex/tools/afterpage.dtx
        texmf-dist/source/latex/tools/afterpage.ins

The CTAN page https://www.ctan.org/pkg/afterpage mentions this :

This package is part of the latex-tools bundle in the LATEX required distribution.

It should already be available in the LaTeX installation

> tlmgr info --list --only-installed tools
package:     tools
category:    Package
shortdesc:   The LaTeX standard tools bundle
longdesc:    A collection of (variously) simple tools provided as part of the LaTeX required tools distribution, comprising the packages: afterpage, array, bm, calc, dcolumn, delarray, enumerate, fileerr, fontsmpl, ftnright, hhline, indentfirst, layout, longtable, multicol, rawfonts, showkeys, somedefs, tabularx, theorem, trace, varioref, verbatim, xr, and xspace.
installed:   Yes
revision:    63514
sizes:       run: 485k
relocatable: No
cat-license: lppl1.3c
cat-topics:  collection
Included files, by type:
run files:
  texmf-dist/tex/latex/tools/.tex
  texmf-dist/tex/latex/tools/afterpage.sty
  texmf-dist/tex/latex/tools/array-2016-10-06.sty
  texmf-dist/tex/latex/tools/array-2020-02-10.sty
  texmf-dist/tex/latex/tools/array.sty
  texmf-dist/tex/latex/tools/bm.sty
  texmf-dist/tex/latex/tools/calc.sty
  texmf-dist/tex/latex/tools/dcolumn.sty
  texmf-dist/tex/latex/tools/delarray.sty
  texmf-dist/tex/latex/tools/e.tex
  texmf-dist/tex/latex/tools/enumerate.sty
  texmf-dist/tex/latex/tools/fontsmpl.sty
  texmf-dist/tex/latex/tools/fontsmpl.tex
  texmf-dist/tex/latex/tools/ftnright.sty
  texmf-dist/tex/latex/tools/h.tex
  texmf-dist/tex/latex/tools/hhline.sty
  texmf-dist/tex/latex/tools/indentfirst.sty
  texmf-dist/tex/latex/tools/layout.sty
  texmf-dist/tex/latex/tools/longtable-2020-01-07.sty
  texmf-dist/tex/latex/tools/longtable.sty
  texmf-dist/tex/latex/tools/multicol-2017-04-11.sty
  texmf-dist/tex/latex/tools/multicol-2019-10-01.sty
  texmf-dist/tex/latex/tools/multicol.sty
  texmf-dist/tex/latex/tools/q.tex
  texmf-dist/tex/latex/tools/r.tex
  texmf-dist/tex/latex/tools/rawfonts.sty
  texmf-dist/tex/latex/tools/s.tex
  texmf-dist/tex/latex/tools/shellesc.sty
  texmf-dist/tex/latex/tools/showkeys-2014-10-28.sty
  texmf-dist/tex/latex/tools/showkeys.sty
  texmf-dist/tex/latex/tools/somedefs.sty
  texmf-dist/tex/latex/tools/tabularx.sty
  texmf-dist/tex/latex/tools/thb.sty
  texmf-dist/tex/latex/tools/thc.sty
  texmf-dist/tex/latex/tools/thcb.sty
  texmf-dist/tex/latex/tools/theorem.sty
  texmf-dist/tex/latex/tools/thm.sty
  texmf-dist/tex/latex/tools/thmb.sty
  texmf-dist/tex/latex/tools/thp.sty
  texmf-dist/tex/latex/tools/trace.sty
  texmf-dist/tex/latex/tools/varioref-2016-02-16.sty
  texmf-dist/tex/latex/tools/varioref.sty
  texmf-dist/tex/latex/tools/verbatim.sty
  texmf-dist/tex/latex/tools/verbtest.tex
  texmf-dist/tex/latex/tools/x.tex
  texmf-dist/tex/latex/tools/xr.sty
  texmf-dist/tex/latex/tools/xspace.sty

Quarto should install the missing .sty files and other (like fonts) for you.

What is the error message you have with Quarto ?

[jpmorr]

@cderv I've removed the afterpage one and then the libfontconfig error came back, so I've installed fontconfig before quarto and now it's working correctly.

[rgaiacs]

I created https://gitlab.com/quarto-forge/docker and I will be building some Docker images to be used primarily by GitLab Pages users. Contributions are welcome!

[Matherion]

Wow, this is awesome!!! 🤩 Thank you! 🙏

[goekce]

Image on the Gitlab registry was not accessible.

Used https://hub.docker.com/u/quarto2forge

[hansfn]

And I have created a PR for quarto.org documenting the usage of these Docker images for GitLab Pages .

[kMygUfvVdbVsuvYjNcZEQEMrMpecJL]

#1994