typst-writing-document

Create and validate Typst documents using command-line compilation workflows.

3.5k|183|Updated Mar 6, 2024
One-click install
npx skills add https://github.com/Myriad-Dreamin/tinymist --skill typst-writing-document
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: typst-writing-document
Source: https://github.com/Myriad-Dreamin/tinymist/tree/main/.codex/skills/typst-writing-document
Command: npx skills add https://github.com/Myriad-Dreamin/tinymist --skill typst-writing-document

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps users create and validate Typst documents with ease by providing a comprehensive guide to the language's grammar and syntax, reducing the time and effort required for authoring and ensuring correct document structure.

Core Features & Use Cases

  • Canonical Grammar Examples: Offers detailed examples to learn and apply Typst's grammar effectively.
  • Validation Workflows: Provides commands to compile documents and validate text and visual output.
  • Use Case: For a Typst document author who needs to ensure proper syntax and rendering, this skill offers step-by-step instructions for compiling and validating their work.

Quick Start

Run the skill by typing typst compile --root . path/to/document.typ target/typst-grammar-authoring-check/document.pdf

Frequently Asked Questions about typst-writing-document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate a Typst document before compiling it to PDF?

To validate a Typst document, you can use the provided canonical grammar examples and validation workflows to check syntax and structure before compiling your document to PDF output.

What is the best way to author Typst documents with correct grammar?

Authoring Typst documents with correct grammar is best achieved by referencing canonical grammar examples that provide detailed syntax guidance, reducing time spent troubleshooting document structure and rendering errors.

How do I compile a Typst file to PDF using the command line?

You can compile a Typst file to PDF by running the command `typst compile --root . path/to/document.typ target/document.pdf`, which processes the document and validates the text and visual output.

Do I need any dependencies to compile and validate Typst documents?

No external dependencies are required to use this Skill for Typst compilation and validation, as it provides the necessary scripts and reference examples to guide the authoring and validation workflow.

Can I validate the visual output of my Typst documents?

Yes, you can validate the visual output of your Typst documents by utilizing the validation workflows provided, which offer commands to compile documents and verify both text and visual rendering.

Why does my Typst document fail to compile correctly?

Typst documents often fail to compile due to improper syntax or structure; using canonical grammar examples helps identify and correct these errors during the validation workflow before final PDF compilation.