Skip to main content

An integrated editor for the typst typesetting system.

Project description

Typstwriter

An integrated editor for the typst typesetting system.

Features

  • Integrated Document Viewer
  • Integrated File System viewer
  • Syntax highlighting

Configuration

Typstwriter can be configured using a configuration file, see example_config.ini for an example config file. After modifying the config file, typstwriter needs to be restarted.

Typstwriter looks for configuration files in the following locations:

  • /etc/typstwriter/typstwriter.ini
  • /usr/local/etc/typstwriter/typstwriter.ini
  • ~/.config/typstwriter/typstwriter.ini
  • ~/.typstwriter.ini
  • ./typstwriter.ini

Files further down in the list will take precedence.

Installation

Using pip:

Typstwriter is available on PyPI. To install using pip simply use:

pip install typstwriter

From source

Get the source code by cloning the desired branch or download a release from th github repository and install from the toplevel directory:

git clone https://github.com/Bzero/typstwriter
pip install ./typstwriter/

Install typst

Independently of the installation method chosen, the typst CLI has to be available to compile typst documents. Consult the typst repository for details on installing typst. Alternatively, the path of a typst executable can be specified in the configuration file.

Development

Clone the repository

git clone https://github.com/Bzero/typstwriter/

Install typstwriter in edit mode

pip install -e ./typstwriter/

Run the tests with pytest to make sure that everything is working correctly. Inside the source directory, run:

pytest

Activate pre-commit hooks to automatically check changes before committing. Inside the source directory, run:

pre-commit install

Contributing

Contributions are always welcome!

License

Typstwriter is licensed under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

typstwriter-0.2.tar.gz (807.2 kB view details)

Uploaded Source

Built Distribution

typstwriter-0.2-py3-none-any.whl (72.2 kB view details)

Uploaded Python 3

File details

Details for the file typstwriter-0.2.tar.gz.

File metadata

  • Download URL: typstwriter-0.2.tar.gz
  • Upload date:
  • Size: 807.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for typstwriter-0.2.tar.gz
Algorithm Hash digest
SHA256 3254c4e74976e1319a99a7a28825d4989d223625969f90adbd0c42ad206caf8a
MD5 fb4f89f45600e5ac78c44431a6cca984
BLAKE2b-256 4151b4158d65164b44b5b1b0dc34e7782bdc4ae317512e09beedf36ca1c090a5

See more details on using hashes here.

File details

Details for the file typstwriter-0.2-py3-none-any.whl.

File metadata

  • Download URL: typstwriter-0.2-py3-none-any.whl
  • Upload date:
  • Size: 72.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for typstwriter-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 47759204180e26a5a80e4fa7a3dfe5c42812c436b49327914caa0f5415d3a5f1
MD5 270571de61a209c246a3388eb3eedbca
BLAKE2b-256 f62b4a12a5854183eb1580f9e64f53e98bb49a47209fd3e2a4ed0ff2a88b102c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page