https://github.com/ggrossetie/kroki-blocks
View diagrams using Kroki!
https://github.com/ggrossetie/kroki-blocks
github-blocks
Last synced: about 1 year ago
JSON representation
View diagrams using Kroki!
- Host: GitHub
- URL: https://github.com/ggrossetie/kroki-blocks
- Owner: ggrossetie
- License: mit
- Created: 2023-03-01T18:11:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-31T17:24:07.000Z (over 3 years ago)
- Last Synced: 2024-05-21T12:26:08.559Z (about 2 years ago)
- Topics: github-blocks
- Language: TypeScript
- Homepage: https://kroki.io
- Size: 97.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Kroki Blocks
Use this repository to render diagrams from textual descriptions inside GitHub!.
## Examples
Visit the _examples_ directory.
## Under the hood
Currently, Blocks are [React](https://reactjs.org/) components. They have a well-defined contract with their surroundings, and receive a [fixed set of props](https://github.com/githubnext/blocks/blob/main/docs/Developing%20blocks/4%20API%20reference%20and%20types.md) when they are instantiated. They are developed in [TypeScript](https://www.typescriptlang.org/), and bundled with [Vite](https://vitejs.dev/).
## More Info
Visit [githubnext/blocks](https://blocks.githubnext.com/githubnext/blocks) for a full tutorial, documentation, and examples.
You should also join us in our discord! There's a [#blocks channel](https://discord.com/channels/735557230698692749/1039950186136469535) where you can connect with us and other folks who are building Blocks:
> 👋 https://discord.gg/githubnext
>
## License
MIT
✌️ ❤️
_GitHub Next_