Skip to content

can1357/pluscal-help

Repository files navigation

PlusCal Cheat Sheet

pluscal.help

A single-page reference for the PlusCal algorithm language (C-Syntax v1.8).

  • Use as a quick reference for PlusCal syntax and constructs while writing specifications,
  • Discover PlusCal features and patterns you might not be familiar with,
  • Learn PlusCal if you already know TLA+ or have formal methods experience.

Development

# Install dependencies
npm install

# Start development server
npm run dev

The dev server will be available at http://localhost:4321

Adding Content

Edit src/content/pluscal-help.md to update the documentation content. The markdown supports:

  • Standard markdown syntax
  • Code blocks with syntax highlighting
  • Tables (automatically styled)
  • Headings (automatically added to TOC)

Contributing

Contributions are very welcome! Please feel free to:

  • Submit bug fixes or improvements via Pull Request
  • File issues for errors or suggestions
  • Propose new examples or clarifications

Credits

  • Leslie Lamport - for creating TLA+ and PlusCal, and the excellent PlusCal User's Manual
  • cheats.rs - for design inspiration
  • Contributors who have improved this resource

Content is based on A PlusCal User's Manual: C-Syntax Version 1.8 by Leslie Lamport.

About

A beautiful, dark-mode cheat sheet for PlusCal.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published