Template for a two column article layout for the Coders’ Compass website. It allows users to write articles in markdown or Typst, which can then be rendered to a PDF suitable for print.

Uses Coders’ Compass branding and styling.

Getting Started

1. Start with the main.typ file which imports the articulate-coderscompass package and demonstrates its usage.
2. Open it in the Typst Web App or use the Typst CLI to render it.

Usage

#import "@preview/articulate-coderscompass:0.1.7": *

#show: articulate-coderscompass.with(
  title: lorem(15),
  subtitle: lorem(10),
  authors: (
    (name: "First Author", email: "first@coderscompass.org", affiliation: "Coders' Compass"),
    (name: "Second Author", email: "second@coderscompass.org", affiliation: "Coders' Compass"),
    // (name: "Third Author", email: "third@coderscompass.org", affiliation: "Coders' Compass"),
  ),
  abstract: [
    #lorem(40)
  ],
  keywords: (
    "keyword1",
    "keyword2",
    "keyword3",
  ),
  version: "1.0.0",
  reading-time: "6 minutes",
  date: datetime.today(),
  bibliography: bibliography("refs.bib", style: "institute-of-electrical-and-electronics-engineers")
)

#render-markdown(read("content.md"))

// Or write Typst directly

= Article Title

Content here.

Refer to the manual for detailed documentation on available features and customization options.

You don’t have to use the render-markdown function. Write Typst directly if you prefer. The reason we use markdown is to have a single manuscript source which can be rendered to both HTML (for the website) and PDF (for print).

Development

Follow the instructions in the official Typst package repository to symlink this package for local development. On MacOS this is what I use:

ln -s ~/path/to/articulate-coderscompass ~/Library/Application\ Support/typst/packages/preview/articulate-coderscompass/<current-version>

Convenience commands for developers and contributors to compile the template, generate the manual, and create thumbnail images.

# Compiling the template
typst c template/main.typ

# Generating the manual
typst c docs/manual.typ docs/manual.pdf --root .

# Thumbnail images
typst c docs/thumbnail.typ --format=png assets/images/page-{p}.png --root .

# Running tests with tytanic
tt run
tt run test1
tt run unit1

Remember to copy any changes to template/main.typ to the test case in tests/test1/test.typ. Also ensure that the contents file is copied over.

License

This project is mostly licensed under the MIT License. This includes all code files and the documentation (manual).

Only exception: the Coders’ Compass branding assets, specifically the logo. All rights reserved on the branding assets (logo), Coders’ Compass.

Acknowledgements

• Typst - The typesetting system powering this package.

  • cmarker - Handles markdown rendering.
  • mitex - LaTeX math rendering support.
  • zebraw - Robust syntax highlighting for code blocks.
  • tidy - Documentation generation.

• Typst Package Template - Template for creating Typst packages.

• tytanic - Test runner for Typst projects.

Contact

For questions, or suggestions, please reach out to the Coders’ Compass team.