Skip to content

angellllk/embellish

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Embellish

Discord's chat Markdown is limited. Embellish extends it via a single user-installed app: use custom / commands to render tables, diagrams, charts, and more.

Status: Early planning.

Architecture and design decisions are documented in docs/.

What's missing in Discord

Discord supports a useful subset of Markdown: bold, italic, lists, headers, code blocks with syntax highlighting. But it stops short of:

  • Tables
  • Mermaid diagrams
  • LaTeX / math expressions
  • Charts and data visualization
  • Inline images from Markdown

Embellish fills that gap.

Architecture

See docs/architecture.md for the high-level design and docs/decisions/ for individual Architecture Decision Records.

Key technology choices:

  • Go for the backend (HTTP Interactions endpoint, render workers)
  • HTTP Interactions over Gateway (stateless, scalable, no always-on connection)
  • Distributed as a User App, one install, available everywhere
  • Cloudflare R2 for rendered output storage

Roadmap

  • Project setup, naming, license
  • Architecture documentation
  • ADRs for major decisions
  • MVP: /mermaid end-to-end
  • MVP: /table
  • Web viewer for interactive output

Contributing

The project is too early for code contributions, but feedback on the architecture and design decisions is very welcome! You can do that by starting a discussion.

License

Apache License 2.0

About

Rich Markdown rendering for Discord chat

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors