https://github.com/penrose/penrose

Create beautiful diagrams just by typing notation in plain text.
https://github.com/penrose/penrose

diagrams domain-specific-language mathematics programming-language visualization

Last synced: 13 days ago
JSON representation

Create beautiful diagrams just by typing notation in plain text.

• Host: GitHub
• URL: https://github.com/penrose/penrose
• Owner: penrose
• License: mit
• Created: 2016-09-22T04:47:19.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2025-03-28T23:56:41.000Z (24 days ago)
• Last Synced: 2025-04-06T06:56:36.122Z (16 days ago)
• Topics: diagrams, domain-specific-language, mathematics, programming-language, visualization
• Language: TypeScript
• Homepage: https://penrose.cs.cmu.edu
• Size: 1.04 GB
• Stars: 7,700
• Watchers: 117
• Forks: 353
• Open Issues: 175
• Metadata Files:
  • Readme: .github/readme_template.hbs
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome - penrose/penrose - Create beautiful diagrams just by typing notation in plain text. (TypeScript)
• awesome-starred - penrose/penrose - Create beautiful diagrams just by typing notation in plain text. (others)
• StarryDivineSky - penrose/penrose - - Penrose 会自动创建一个满足您所有约束条件的新图表。 (前端开发框架及项目 / 其他_文本生成、文本对话)
• my-awesome - penrose/penrose - specific-language,mathematics,programming-language,visualization pushed_at:2025-04 star:7.7k fork:0.4k Create beautiful diagrams just by typing notation in plain text. (TypeScript)

README

        
# Penrose [![npm (scoped)](https://img.shields.io/npm/v/@penrose/core)](https://www.npmjs.com/package/@penrose/core) [![license](https://img.shields.io/github/license/penrose/penrose)](LICENSE) [![Build](https://github.com/penrose/penrose/actions/workflows/build.yml/badge.svg)](https://github.com/penrose/penrose/actions/workflows/build.yml) [![Discord](https://dcbadge.vercel.app/api/server/a7VXJU4dfR?style=flat)](https://discord.gg/a7VXJU4dfR) [![Twitter: @UsePenrose](https://img.shields.io/badge/follow-%40UsePenrose-1DA1F2?logo=twitter&style=social)](https://twitter.com/UsePenrose)

[Penrose](https://penrose.cs.cmu.edu/) is a platform that enables people to

**create beautiful diagrams just by typing notation in plain

text.** The goal is to make it easy for non-experts to create and explore

high-quality diagrams and provide deeper insight into challenging technical

concepts. We aim to democratize the process of creating visual intuition.

## Usage

You can [try Penrose in your browser](https://penrose.cs.cmu.edu/try/index.html)

without any installation. For a more detailed step-by-step introduction, check

out our [tutorials](https://penrose.cs.cmu.edu/docs/tutorial/welcome). Or, for

more reference-style information, take a look at our

[documentation](https://penrose.cs.cmu.edu/docs/ref).

## Example

Here's a simple Penrose visualization in the domain of set theory.



It's specified by the following trio of Domain, Substance, and Style programs

(with variation `{{variation}}`):

- `{{dsl}}`:

  ```

  {{> domain }}

  ```

- `{{sub}}`:

  ```

  {{> substance }}

  ```

- `{{sty}}`:

  ```

  {{> style }}

  ```

## Contributing

See [`CONTRIBUTING.md`](CONTRIBUTING.md).

## License

This repository is licensed under the [MIT License](LICENSE).