https://google.github.io/typograms/

https://google.github.io/typograms/

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://google.github.io/typograms/
• Owner: google
• License: apache-2.0
• Created: 2022-08-23T20:54:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-18T00:24:10.000Z (about 1 year ago)
• Last Synced: 2024-10-14T10:40:51.763Z (2 months ago)
• Language: JavaScript
• Size: 113 KB
• Stars: 1,266
• Watchers: 6
• Forks: 17
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-practices - Typograms - Lightweight image format useful for defining simple diagrams in technical documentation. (Tools)

README

        
# typograms

Typograms (short for typographic diagrams) is a lightweight image format

 (`text/typogram`) useful for defining simple diagrams in technical 

documentation, originally developed [here](https://code.sgo.to/2022/06/20/typographic-diagrams.html).

See it in action here:

https://google.github.io/typograms/

Like markdown, typograms is heavily inspired by pre-existing conventions 

found in ASCII diagrams. A small set of primitives and rules to connect

them is defined, which you can use to build larger diagrams.

Typograms optimizes for editability and portability (e.g. plain text is

easy to maintain, change, store and transmit), at the cost of expressivity

(e.g. SVG is more expressive) and ergonomics (e.g. higher level tools

produce diagrams faster).

You can embed typograms into pages using the JS rendering library: 

```html

  

  

+----+

|    |---> My first diagram!

+----+

  

```

A comparison with related work is available [here](https://google.github.io/typograms/#related).