Skip to content

jonathan-iksjssen/jx-style

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation

jx-style

@joniksj's personal style package for his typst documents. Recommended for use if you are him, or if you want to make your documents look like his.

Installation

Of course, to use this, you'll need typst.

If you haven't heard, typst is a newfangled document typesetting system akin to LaTeX, also exporting directly to .pdf, that uses more modern syntax (thank god), familiar programming concepts, and has a powerful styling engine, which makes it perfect for me, @joniksj, that wanted an alternative to Google Docs but didn't want to learn LaTeX.

Dependencies

  • An installation of Typst, either the binary from the releases page or from @nvarner's typst-lsp for VS Code(ium)
  • A text editor to actually test this out with (I recommend VS Code(ium) with typst-lsp)
  • Git CLI (optional, to make things easier)

Installation Instructions

With `git clone`

You will need to use git for this.

  1. Navigate to your typst local packages directory, which is:
  • $XDG_DATA_HOME/typst/packages or ~/.local/share/typst/packages on Linux
  • ~/Library/Application Support/typst/packages on macOS
  • %APPDATA%/typst/packages on Windows
  1. Make a folder called local (or whatever you want to name your package namespace)
  2. In that local folder, open a terminal and run:
    git clone https://github.com/jonathan-iksjssen/jx-style.git
  3. Make a new .typ file anywhere
  4. Import the package with
     #import "@local/jx-style:0.2.0": *
    Replace local with whatever you named your package namespace in step 2.
Without `git clone`
  1. Download the .zip file of this repository.
  2. Navigate to your typst local packages directory, which is:
  • $XDG_DATA_HOME/typst/packages or ~/.local/share/typst/packages on Linux
  • ~/Library/Application Support/typst/packages on macOS
  • %APPDATA%/typst/packages on Windows
  1. Make a folder called local (or whatever you want to name your package namespace) and navigate into it.
  2. Extract the contents of jx-style-main.zip directly into said folder.
  3. If necessary, rename the jx-style-main folder to just jx-style.
  4. Make a new .typ file anywhere
  5. Import the package with
     #import "@local/jx-style:0.2.0": *
    Replace local with whatever you named your package namespace in step 2.

Parts

There are four main parts of this package that are important:

File Purpose
irgot.typ (is irgot.json in 0.1.0) Contains the colour schemes that are possible for documents. ‹irgot› means ‹colours› in Icsine, my personal conlang.
jx-style.typ The main style file, and the entry point to the package itself. Contains all the styles themselves, all that shabang.
jx-date.typ My own date string formatter. Accessed by jx-style.typ to display dates how I like it.
typst.toml The manifest for the package, in accordance with typst/packages.

irgot.typ

A bit of backstory -- before I moved to making my documents with Typst,

About

@joniksj's personal style package for his typst documents

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages