Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added tutorial gif #20

Merged
merged 2 commits into from
Nov 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,16 @@
A [d2](https://github.com/terrastruct/d2) extension for Emacs. This was heavily
inspired (it's basically a fork) of [Mermaid Mode](https://github.com/abrochard/mermaid-mode).

**Status:** Pre-Alpha. Known issue with libmagick rendering of SVGs. Check the issues for more details.
**Status:** Alpha

<div>
<img height="500px" alt="image" src="https://user-images.githubusercontent.com/8604639/204498003-08bd0e05-0e0b-4d60-8d94-1ed95a4a7cd3.png">
</div>

<div>
<img height="500px" alt="image" src="tutorial.gif">
</div>

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->

**Table of Contents**
Expand Down Expand Up @@ -110,6 +114,11 @@ See the `snippets` folder for yas snippets. Start making d2 graphs today!

## Bugs & Issues

- libmagick and M1's have some issues. 1) it's not by default supported in the emacsformac install or the cask install and 2. There are some issues with rendering svg from emacs side. See https://github.com/andorsk/d2-mode/issues/13 and https://github.com/andorsk/d2-mode/issues/8 for more details.
- libmagick and M1's have some issues. 1) it's not by default supported in the
emacsformac install or the cask install and 2. There are some issues with
rendering svg from emacs side. See
https://github.com/andorsk/d2-mode/issues/13 and
https://github.com/andorsk/d2-mode/issues/8 for more details. You can use the
`*browse` commands to render it directly in your browser instead!

Feel free to open an issue!
Binary file added tutorial.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.