{"id":29184354,"url":"https://github.com/thinkr-open/squash","last_synced_at":"2025-07-01T21:31:04.779Z","repository":{"id":266650128,"uuid":"898925533","full_name":"ThinkR-open/squash","owner":"ThinkR-open","description":"Several Quarto to Single HTML","archived":false,"fork":false,"pushed_at":"2025-04-22T13:05:05.000Z","size":5884,"stargazers_count":8,"open_issues_count":9,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-22T13:29:57.555Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://thinkr-open.github.io/squash","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ThinkR-open.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-05T09:49:35.000Z","updated_at":"2025-04-01T07:19:20.000Z","dependencies_parsed_at":"2024-12-05T11:33:45.057Z","dependency_job_id":"c3c3724e-19d4-4314-a3bf-45d8ae34ea88","html_url":"https://github.com/ThinkR-open/squash","commit_stats":null,"previous_names":["thinkr-open/squash"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ThinkR-open/squash","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThinkR-open%2Fsquash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThinkR-open%2Fsquash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThinkR-open%2Fsquash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThinkR-open%2Fsquash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThinkR-open","download_url":"https://codeload.github.com/ThinkR-open/squash/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThinkR-open%2Fsquash/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263038877,"owners_count":23404076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-01T21:31:02.727Z","updated_at":"2025-07-01T21:31:04.737Z","avatar_url":"https://github.com/ThinkR-open.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\"\n)\n```\n\n# {squash}: several quarto to single html \u003cimg src=\"man/figures/logo.png\" align=\"right\" height=\"138\" alt=\"\" /\u003e\n\u003c!-- badges: start --\u003e\n[![R-CMD-check](https://github.com/ThinkR-open/squash/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ThinkR-open/squash/actions/workflows/R-CMD-check.yaml)\n[![Codecov test coverage](https://codecov.io/gh/ThinkR-open/squash/graph/badge.svg)](https://app.codecov.io/gh/ThinkR-open/squash)\n\u003c!-- badges: end --\u003e\n\nThe goal of {squash} is to compile a single html presentation file from multiple independent quarto files.\n\nThe main purpose of this is to create custom slide decks from several quarto chapter files.\n\nThe resulting revealjs presentation can be themed via quarto extensions.\n\n```{r, fig.align = 'center', echo=FALSE}\n#| fig.alt: \u003e\n#|   A simple schematic view of squash input and output\nknitr::include_graphics(\"man/figures/simple_scheme.png\")\n```\n\n\n\n## Installation\n\nYou can install the **stable** version from [GitHub](https://github.com/Thinkr-open/squash) with:\n\n```{r eval=FALSE}\nremotes::install_github(\"Thinkr-open/squash\", ref = \"production\")\n```\n\n\nYou can install the **development** version from [GitHub](https://github.com/Thinkr-open/squash) with:\n\n```{r eval=FALSE}\nremotes::install_github(\"Thinkr-open/squash\", ref = \"main\")\n```\n\nThis package relies on quarto \u003e 1.3 (see its [download page](https://quarto.org/docs/download/)).\n\n## Play with {squash}\n\n### TL;DR\n\nGiven the vector `qmds` containing paths to one or several qmd revealjs presentation, you can use the function `compile_qmd_course()` to compile a full presentation.\n\n```{r, eval=FALSE}\nlibrary(squash)\n\nhtml_output \u003c- compile_qmd_course(\n  vec_qmd_path = qmds,\n  output_dir = tempdir(),\n  output_html = \"complete_course.html\"\n)\n```\n\nCheck out the result\n```{r eval=FALSE}\nbrowseURL(html_output)\n```\n\n### Tutorials\n\nYou can find find a full tutorial on how to create your first {squash}-made html [here](https://thinkr-open.github.io/squash/articles/simple-example-usage.html).\n\nEager to spice it up? Take a look at some advanced usage doc :\n\n- using quarto themes and extensions: [here](https://thinkr-open.github.io/squash/articles/advanced-usage-theme.html)\n- using a personalized template: [here](https://thinkr-open.github.io/squash/articles/advanced-usage-template.html)\n- using parallel workers with `{future}`: [here](https://thinkr-open.github.io/squash/articles/advanced-usage-future.html)\n\n### Related tools\n\nNot quite what you were looking for? Here are two closely related quarto tools :\n\n- exporting as a book instead of a slide deck: [quarto book](https://quarto.org/docs/books/)\n- including snippets instead of full quarto chapters: [Include shortcodes](https://quarto.org/docs/authoring/includes.html)\n\n## Contribute\n\nReady to help? Take a look at the [contribution guidelines](https://thinkr-open.github.io/squash/articles/dev-contribute.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthinkr-open%2Fsquash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthinkr-open%2Fsquash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthinkr-open%2Fsquash/lists"}