Skip to content

This devcontainer provides a ready-to-use environment for editing and scripting Typst documents. It comes pre-installed with Git, Typst, Pandoc, and a set of extensions for both code and prose workflows.

Notifications You must be signed in to change notification settings

Accommodus/Typst-Editor-devcontainer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Typst Editor Dev Container

This editor is configured to look best with a font that is not pre-installed; see Font Installation for details.

This devcontainer provides a ready-to-use environment for editing and scripting Typst documents. It comes pre-installed with Git, Typst, Pandoc, and a set of extensions for both code and prose workflows. System-wide installation of all Google Fonts and the Monaspace family ensures consistent, high-quality typography for all documents, eliminating the need to manually add fonts.

Installation

If This Is Your Only Dev Container

Add this Dev Container directly as your .devcontainer folder:

  1. Navigate to your project’s root directory.

  2. Create the config file with the following content:

    echo '{ "image": "ghcr.io/accommodus/typst-editor-devcontainer:latest" }' > .devcontainer.json

If You Want Multiple Dev Containers

If your project needs more than one Dev Container (for example, one for code and one for writing papers), you can organize each configuration in its own subdirectory:

  1. Navigate to your project’s root directory.

  2. Create the .devcontainer/typst_editor/devcontainer.json file with the following content::

    mkdir -p .devcontainer/typst_editor/ && echo '{ "image": "ghcr.io/accommodus/typst-editor-devcontainer:latest" }' > .devcontainer/typst_editor/devcontainer.json
  3. When reopening the project, select the desired Dev Container configuration from the list.

If You Want to Use Monaspace Xenon in Your Editor

Instructions based on your operating system. See this.

Usage

  1. Open the project in VS Code
  2. Install the Dev Containers extension
  3. Press F1 or Shift+Ctrl+P to open the Command Palette and select Dev Containers: Reopen in Container.
  4. You are ready to use Typst.

Features

Preconfigured Settings

The editor settings are tailored to create an ideal environment for both scripting and drafting documents in Typst.

  • Uses the Monaspace Xenon font if installed (with ligatures and weight 500) for a modern, consistent look across code and prose.
  • Font size set to 16 px for comfortable, accessible reading and editing.
  • Automatic formatting on save ensures consistent code style.
  • Editor wraps lines for easier reading and editing of long paragraphs or code.

VS Code Extensions

  • From features

    • Tinymist Typst (Myriad Dreamin)

About

This devcontainer provides a ready-to-use environment for editing and scripting Typst documents. It comes pre-installed with Git, Typst, Pandoc, and a set of extensions for both code and prose workflows.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages