A Typst template for academic documents following UFPR (Federal University of Paraná) formatting guidelines.

1. Download Typst:

   • Go to Typst Releases
   • Download typst-x86_64-pc-windows-msvc.zip for Windows

2. Extract and Setup:

   • Save the ZIP file to a folder on your computer
   • Extract the contents of the ZIP file
   • Open Command Prompt (cmd) or PowerShell
   • Navigate to the extracted folder containing the Typst executable

3. Add to PATH (Optional but Recommended):

   • Copy the Typst executable to a directory in your system's PATH
   • Or add the Typst folder to your system's PATH environment variable
   • This allows you to run typst from any directory

1. Install Typst (if not already installed):

   # Alternatively, you can install via package managers:
   # Windows (Winget):
   winget install typst
   
   # Or using cargo (Rust package manager):
   cargo install typst

2. Clone or download this repository

3. Compile your document:

   typst compile main.typ

4. Watch for changes (development):

   typst watch main.typ

• Typst installed on your system
• Basic understanding of Typst syntax
• Text editor for modifying .typ files

• UFPR-compliant formatting
• Academic document structure
• Customizable templates for theses, dissertations, and academic papers
• Automatic bibliography handling
• Support for multiple languages

For more information about Typst, visit: https://typst.app/

1. Install Typst:

   # Windows (using Winget)
   winget install typst
   
   # Or download from GitHub releases:
   # Visit https://github.com/typst/typst/releases
   # Download typst-x86_64-pc-windows-msvc.zip
   # Extract and add to your PATH

2. Create a new GitHub repository for your Typst project

3. Clone your repository:

   git clone https://github.com/your-username/your-repo-name.git
   cd your-repo-name

4. Add your Typst files to the repository:

   • main.typ (main document file)
   • template.typ (template configuration)
   • references.bib (bibliography file, if needed)
   • Any image assets or additional files

5. Configure .gitignore (create a .gitignore file):

   # Typst build outputs
   *.pdf
   /output/
   
   # OS files
   .DS_Store
   Thumbs.db
   
   # Editor files
   .vscode/
   .idea/
   

6. Commit and push your files:

   git add .
   git commit -m "Initial Typst project setup"
   git push origin main

Create .github/workflows/build.yml:

name: Build Typst Document

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    
    - name: Setup Typst
      uses: typst/setup-typst@v2
      with:
        version: latest
        
    - name: Build PDF
      run: typst compile main.typ main.pdf
      
    - name: Upload PDF artifact
      uses: actions/upload-artifact@v4
      with:
        name: document
        path: main.pdf

1. Start watching for changes:

   typst watch main.typ

   This automatically recompiles when files change

2. Compile manually:

   typst compile main.typ output.pdf

3. Add new dependencies (if using packages):

   #import "@preview/package:0.1.0": *

your-repo/
├── .github/
│   └── workflows/
│       └── build.yml
├── assets/
│   ├── images/
│   └── fonts/
├── main.typ
├── template.typ
├── references.bib
├── README.md
└── .gitignore

• Use GitHub Issues for tracking tasks
• Create Pull Requests for changes
• GitHub Actions automatically builds PDF on push
• Use GitHub Pages to host the compiled document

For more information about Typst, visit: https://typst.app/

# First install Typst (if you haven't already)
# Windows with Winget:
winget install typst

# Or download manually:
# Visit https://github.com/typst/typst/releases
# Download typst-x86_64-pc-windows-msvc.zip
# Extract and add to system PATH

# Open Command Prompt or PowerShell
git clone https://github.com/username/repository-name.git
cd repository-name

# Check project files
dir   # Windows
ls    # Linux/Mac

# Compile main file
typst compile main.typ

# Or specify input and output files
typst compile document.typ output.pdf

# Development mode (auto-recompiles on changes)
typst watch main.typ

# Check if Typst is installed
typst --version

# If command not found, add to PATH
# Or use full path to executable
C:\path\to\typst.exe compile main.typ

1. Verify all images/assets are in correct locations
2. Check package versions in the code
3. Review project's README.md for specific instructions

typst-project/
├── main.typ              # Main document file
├── template.typ          # Custom template
├── references.bib        # Bibliography (optional)
├── assets/               # Images and resources
│   ├── images/
│   └── fonts/
├── .gitignore           # Files ignored by Git
└── README.md            # Project instructions

# Compile to PDF
typst compile input.typ output.pdf

# Compile and open automatically
typst compile --open main.typ

# Get Typst help
typst --help

# Check version
typst --version

1. Always check the README.md for project-specific instructions
2. Review requirements (Typst version, additional packages)
3. Keep Typst updated: winget upgrade typst
4. Use typst watch during development for real-time preview

Need help with a specific project? Send me the repository link!