|
| 1 | +--- |
| 2 | +layout: default |
| 3 | +title: Introduction to Typst and Recommended HiMCM Collaboration Workflows |
| 4 | +permalink: /math-talks/typst-himcm-collab-workflows/ |
| 5 | +--- |
| 6 | + |
| 7 | +# Introduction to Typst and Recommended HiMCM Collaboration Workflows |
| 8 | + |
| 9 | +## What is Typst |
| 10 | + |
| 11 | +### What Are Typesetting Languages? |
| 12 | + |
| 13 | +- Typesetting languages are specialized systems that control how text appears on a page or screen |
| 14 | +- Instead of clicking formatting buttons like in Microsoft Word, you write simple codes or commands that tell the computer how to arrange text, equations, images, and other elements |
| 15 | +- They handle complex formatting automatically: page numbers, footnotes, citations, table of contents, mathematical equations, and consistent styling throughout your document |
| 16 | +- Originally used for professional printing, they're now essential for creating academic papers, technical documents, and books |
| 17 | +- The main benefit: you focus on writing content while the system handles all the visual formatting rules consistently |
| 18 | + |
| 19 | +### Why Use Typst |
| 20 | + |
| 21 | +#### Advantages over Microsoft Word/other office apps |
| 22 | + |
| 23 | + |
| 24 | +- Compatibility |
| 25 | + |
| 26 | + {: width="50%"} |
| 27 | +- Full precise control over documents |
| 28 | + |
| 29 | + {: width="60%"} |
| 30 | +- No leaving the keyboard (even for document settings) |
| 31 | +- Convenient math input (also keyboard only) |
| 32 | +- Pure text format: git tracking and AI collaboration (important features of the workflow I'll introduce) |
| 33 | + |
| 34 | +#### Advantages over LaTeX |
| 35 | + |
| 36 | +- Fast: Compiles documents in under 5 seconds versus minutes with LaTeX |
| 37 | +- Easy to learn: Clean, readable syntax similar to Markdown—no confusing backslashes or brackets (including simplified math inputs) |
| 38 | +- Clear error messages: Understandable explanations instead of cryptic technical errors that frustrate beginners |
| 39 | +- Real-time preview: See your formatted paper instantly as you type |
| 40 | +- Built-in citation handling: Automatic bibliography and reference management |
| 41 | +- Modern programming features: Variables and functions make complex documents easier to automate |
| 42 | + |
| 43 | +## Overview of Typst |
| 44 | + |
| 45 | +- [https://typst.app](https://typst.app) |
| 46 | + |
| 47 | +# Suggested Collaboration Workflows for HiMCM |
| 48 | + |
| 49 | +## Basic: fully online real-time collaboration using [typst.app](https://typst.app) |
| 50 | + |
| 51 | +Copy the file contents/download the entire project as zip and use any AI to debug/add features |
| 52 | + |
| 53 | +## Advanced: Windsurf + git + P2P Live Share |
| 54 | + |
| 55 | +- Requires at least 1 member in the team to have git knowledge, optimally all members, [git guide from PHGameStudio website](https://phgamestudio.github.io/resources/git-guide/) |
| 56 | + - All members need to know how to commit, checkout, push, and pull/fetch in git |
| 57 | +- Install [Windsurf](https://windsurf.com/) and install the [tinymist typst](https://open-vsx.org/extension/myriad-dreamin/tinymist) plugin to edit typst with real-time preview |
| 58 | +- You can get unlimited free trials by following the guide on [the PHGameStudio website](https://phgamestudio.github.io/) |
| 59 | +- Use git for large edits made by 1 person |
| 60 | +- Use the [P2P Live Share plugin](https://open-vsx.org/extension/kermanx/p2p-live-share) for meeting edits where multiple people edit the same part simultaneously |
0 commit comments