{"id":22270344,"url":"https://github.com/botprof/qu-handout","last_synced_at":"2025-03-25T15:46:11.546Z","repository":{"id":49409551,"uuid":"412879157","full_name":"botprof/qu-handout","owner":"botprof","description":"LaTeX template for making simple handouts for engineering courses or for other technical purposes.","archived":false,"fork":false,"pushed_at":"2024-01-14T17:07:28.000Z","size":1929,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T14:14:53.125Z","etag":null,"topics":["latex-template"],"latest_commit_sha":null,"homepage":"","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/botprof.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-02T18:23:46.000Z","updated_at":"2023-04-06T03:33:34.000Z","dependencies_parsed_at":"2023-01-18T20:46:35.814Z","dependency_job_id":null,"html_url":"https://github.com/botprof/qu-handout","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botprof%2Fqu-handout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botprof%2Fqu-handout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botprof%2Fqu-handout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botprof%2Fqu-handout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/botprof","download_url":"https://codeload.github.com/botprof/qu-handout/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245493291,"owners_count":20624465,"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":["latex-template"],"created_at":"2024-12-03T12:08:08.482Z","updated_at":"2025-03-25T15:46:11.525Z","avatar_url":"https://github.com/botprof.png","language":"TeX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qu-handout: Course Handout LaTeX Class and Template\n\nThis is a LaTeX template for making simple handouts for courses or other technical purposes.\n\n## Example Output\n\nSee the [example PDF output](https://github.com/botprof/qu-handout/blob/main/qu-handout-example.pdf) included in this repository.\n\n## Dependencies\n\nThis template requires a number of packages, each loaded in the [qu-handout.cls](qu-handout.cls) file.  Most notably, the Queen's standard font is the free font [Open Sans](https://fonts.google.com/specimen/Open+Sans), which this template incorporates by using the [opensans package](https://tug.org/FontCatalogue/opensans/).  If you prefer a different font, you can do that in the [qu-handout.cls](qu-handout.cls) by changing the appropriate lines.\n\n### Code and Syntax Highlighting\n\nThis template includes functionality for syntax highlighting of code snippets using the [minted](https://www.ctan.org/pkg/minted) package.  Overleaf has a nice [introduction to minted](https://www.overleaf.com/learn/latex/Code_Highlighting_with_minted).\n\nMinted requires the installation of additional software, Pygments.  Section 2.1 of [the minted documentation](https://mirror.csclub.uwaterloo.ca/CTAN/macros/latex/contrib/minted/minted.pdf) describes how to install Pygments.  If you use macOS, the easiest way is probably to just [install Pygments using Homebrew](https://formulae.brew.sh/formula/pygments#default).\n\nWhen running LaTeX and using minted, you must invoke it with the `-shell-escape` flag so that it can access Pygments.  For example, if you are using Visual Studio Code as an IDE with the LaTeX Workshop extension and compile your document using `latexmk`, then you can edit the `settings.json` file to include the flag, as shown in the example snippet below.\n\n```json\n\"latex-workshop.latex.tools\":[\n    {\n        \"name\": \"latexmk\",\n        \"command\": \"latexmk\",\n        \"args\": [\n            \"-shell-escape\",\n            \"-synctex=1\",\n            \"-interaction=nonstopmode\",\n            \"-file-line-error\",\n            \"-pdf\",\n            \"-outdir=%OUTDIR%\",\n            \"%DOC%\"\n        ],\n        \"env\": {}\n    },\n```\n\nIf you do not need this functionality, then you can simply comment out these lines shown below in the [qu-handout.cls](qu-handout.cls) file and be sure to not use minted commands in your document.\n\n```latex\n% For code (usually Python or C/C++)\n\\RequirePackage[]{minted}\n\\setminted[python]{linenos=true}\n\\setminted[c]{linenos=true}\n\\renewcommand\\theFancyVerbLine{\\sffamily\\footnotesize\\arabic{FancyVerbLine}}\n\\BeforeBeginEnvironment{minted}{\\begin{snugshade}}\n\\AfterEndEnvironment{minted}{\\end{snugshade}}\n\\newcommand*{\\mintpy}[1]{\\mintinline[bgcolor=shadecolor]{python}{#1}}\n\\newcommand*{\\mintc}[1]{\\mintinline[bgcolor=shadecolor]{c}{#1}}\n```\n\n## Contact the Author\n\n[Joshua Marshall](https://www.ece.queensu.ca/people/j-marshall), PhD, PEng  \n[Department of Electrical and Computer Engineering](https://www.ece.queensu.ca)  \n[Queen's University](http://www.queensu.ca)  \nKingston, ON K7L 3N6 Canada  \n+1 (613) 533-2921  \n[joshua.marshall@queensu.ca](mailto:joshua.marshall@queensu.ca)\n\n## License\n\nThe code associated with this class and template is subject to an [MIT License](LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbotprof%2Fqu-handout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbotprof%2Fqu-handout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbotprof%2Fqu-handout/lists"}