{"id":22901276,"url":"https://github.com/mooerslab/writinglogintypst","last_synced_at":"2026-03-19T23:57:06.947Z","repository":{"id":258224268,"uuid":"871467883","full_name":"MooersLab/writingLogInTypst","owner":"MooersLab","description":"Template in typst for writing log for scientific journal article","archived":false,"fork":false,"pushed_at":"2024-11-01T17:32:34.000Z","size":212,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-07T03:41:59.005Z","etag":null,"topics":["template","typst","writing-log-for-journal-article","writing-project-management"],"latest_commit_sha":null,"homepage":"","language":"Typst","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MooersLab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"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}},"created_at":"2024-10-12T03:46:02.000Z","updated_at":"2024-11-01T17:32:37.000Z","dependencies_parsed_at":"2025-02-07T03:41:42.022Z","dependency_job_id":"b25985c7-459b-446b-b4d4-c8a0ac9ff356","html_url":"https://github.com/MooersLab/writingLogInTypst","commit_stats":null,"previous_names":["mooerslab/writinglogintypst"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MooersLab%2FwritingLogInTypst","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MooersLab%2FwritingLogInTypst/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MooersLab%2FwritingLogInTypst/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MooersLab%2FwritingLogInTypst/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MooersLab","download_url":"https://codeload.github.com/MooersLab/writingLogInTypst/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246591782,"owners_count":20801984,"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":["template","typst","writing-log-for-journal-article","writing-project-management"],"created_at":"2024-12-14T01:32:40.513Z","updated_at":"2026-01-08T17:32:51.452Z","avatar_url":"https://github.com/MooersLab.png","language":"Typst","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Version](https://img.shields.io/static/v1?label=manuscriptInTypst\u0026message=0.2\u0026color=brightcolor)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\n# Writing log template in Typst for journal article\n\nA nice introduction to Typst in October 2024 by Dr. Chase Brown of the University of Central Florida is found [here](https://mediasite.ouhsc.edu/Mediasite/Channel/python/browse/null/most-recent/null/0/null).\n\n## Purpose\n\nSupport the preparation of a scientific journal article for submission by providing space for thinking and planning the manuscript rather than doing this in the margins of the manuscript document.\n\n## What is typst?\n\nA type-setting program built on top of the programming language Rust. \nIt compiles small documents almost instantly, so it can be used interactively. \nThe [typst.app](https://typst.app) is analogous to Overleaf in the LaTeX world.\n\n## Features\n\n- table of contents\n- Project initiation metadata\n- Project management metadata\n- Daily log\n- To dos\n- Future off-shoots\n- Protocols\n- List of typst links\n- index\n- bibliography\n- single- and double-spacing\n- running title in header\n- 1/N page numbering\n- BibLaTeX \n\n## Sample of first page\n\n\u003cimg width=\"1586\" alt=\"Screenshot 2024-10-11 at 10 41 04 PM\" src=\"https://github.com/user-attachments/assets/beb81060-0ae0-40ad-b51a-e35137902767\"\u003e\n\n\n## Contents\n- typst source file template\n- biblatex file\n- sample PDF\n- wordcount.csv\n\n\n## Requirements\n\n- typst version 0.11.0 or more recent\n- in-dexter v0.6.0 to generate an index (optional).\n- cheq v0.2.0 to generate checklists (optional)\n\n## How to install packages locally\n\nGit clone the package in {data-dir}/typst/packages/{namespace}/{name}/{version} to make it available on your system. \n\nHere, {data-dir} is one of the following:\n\n*Linux:*   $XDG_DATA_HOME or ~/.local/share on Linux\n*MacOS:*    ~/Library/Application Support on macOS\n*Windows:*  %APPDATA% on Windows\n\nPackages in the data directory have precedence over ones in the cache directory. \nA good namespace for system-local packages is local:\nImport the package in your typst file with `#import \"@local/mypkg:1.0.0\": *`.\n\n\n## Bash or zsh function to compile to PDF and open in Preview.app on Mac (optional)\n\nTypst compiles the *.typfile so quickly that you might as well pop open the PDF: `typc \u003cfilename prefix\u003e`.\n\n```bash\nfunction typc {\necho \"Compile typst file to PDF and display PDF file.\"\nif [ $# -lt 1 ]; then\n  echo 1\u003e\u00262 \"$0: not enough arguments\"\n  echo \"Usage1: typc \u003cfilename prefix\u003e\"\n  return 2\nelif [ $# -gt 1 ]; then\n  echo 1\u003e\u00262 \"$0: too many arguments\"\n  echo \"Usage1: typc  \u003ctypst filename prefix\u003e\"\n  return 2\nfi\ntypst compile $1.typ \u0026\u0026 pre $1.pdf\n}\n```\n\n## Bash or zsh function to preview typst file with tinymist (optional)\n\nYes, I hate typing: `tmp \u003ctypst filename prefix\u003e\"\n\n```bash\nfunction tmp {\necho \"Preview typst file in browser via tinymist.\"\nif [ $# -lt 1 ]; then\n  echo 1\u003e\u00262 \"$0: not enough arguments\"\n  echo \"Usage1: tmp \u003cfilename prefix\u003e\"\n  return 2\nelif [ $# -gt 1 ]; then\n  echo 1\u003e\u00262 \"$0: too many arguments\"\n  echo \"Usage1: typc  \u003cfilename prefix\u003e\"\n  return 2\nfi\ntinymist preview $1.typ\n}\n```\n\n## Optional bash functions to ease copying the template to a new project\n\nStore in `.bashrc` or `.zshrc`.\nEdit file paths to suit.\nTwo functions are provided, so you do not have to remember the order of the component names in the function name.\n\n```bash\nfunction typlog {\necho \"Copy template writing log in typst with project number in title.\"\nif [ $# -lt 1 ]; then\n  echo 1\u003e\u00262 \"$0: not enough arguments\"\n  echo \"Usage1: typlog projectID\"\n  return 2\nelif [ $# -gt 1 ]; then\n  echo 1\u003e\u00262 \"$0: too many arguments\"\n  echo \"Usage1: typlog projectID\"\n  return 2\nfi\nprojectID=\"$1\"\necho \"Write writing log to log$1.typ file.\"\ncp  ~/6112MooersLabGitHubLabRepos/writingLogInTypst/logTemplate.org log$1.typ\ncp  ~/6112MooersLabGitHubLabRepos/writingLogTemplateInTypst/wordcount.csv .\ncp  ~/6112MooersLabGitHubLabRepos/writingLogTemplateInTypst/template.bib $1.bib\n}\n\nfunction logtyp {\necho \"Copy template writing log in typst with project number in title.\"\nif [ $# -lt 1 ]; then\n  echo 1\u003e\u00262 \"$0: not enough arguments\"\n  echo \"Usage1: logtyp projectID\"\n  return 2\nelif [ $# -gt 1 ]; then\n  echo 1\u003e\u00262 \"$0: too many arguments\"\n  echo \"Usage1: logtyp projectID\"\n  return 2\nfi\nprojectID=\"$1\"\necho \"Write writing log to log$1.typ file.\"\ncp  ~/6112MooersLabGitHubLabRepos/writingLogInTypst/logTemplate.org log$1.typ\ncp  ~/6112MooersLabGitHubLabRepos/writingLogTemplateInTypst/wordcount.csv .\ncp  ~/6112MooersLabGitHubLabRepos/writingLogTemplateInTypst/template.bib $1.bib\n}\n```\n\n\n## Update history\n\n|Version       |Changes                                                                                               |Date                 |\n|:-------------|:-----------------------------------------------------------------------------------------------------|:--------------------|\n| Version 0.1  | Initiate project. Added badges, funding, and update table.                                           | 2024 October 11     |\n| Version 0.2  | Added two bash convience functions to README.md.                                                     | 2024 October 19     |\n\n## Sources of funding\n\n- NIH: R01 CA242845\n- NIH: R01 AI088011\n- NIH: P30 CA225520 (PI: R. Mannel)\n- NIH: P20 GM103640 and P30 GM145423 (PI: A. West)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmooerslab%2Fwritinglogintypst","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmooerslab%2Fwritinglogintypst","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmooerslab%2Fwritinglogintypst/lists"}