Skip to content

Commit

Permalink
docs(goldmark-jupyter): add illustrations to README
Browse files Browse the repository at this point in the history
  • Loading branch information
bevzzz committed Jan 26, 2024
1 parent bbb8e04 commit d694010
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion extension/extra/goldmark-jupyter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ Markdown (and raw) cells can have a number of attachments, typically inline imag

`goldmark-jupyter` helps [`goldmark`](https://github.com/yuin/goldmark) recognise [cell attachments](https://nbformat.readthedocs.io/en/latest/format_description.html#cell-attachments) and include them in the rendered markdown correctly.


| `goldmark` | `goldmark-jupyter` |
| ----------- | ----------- |
| ![img](./assets/goldmark.png) | ![img](./assets/goldmark-jupyter.png) |

## Installation

```sh
Expand Down Expand Up @@ -44,7 +49,7 @@ if err := c.Convert(io.Stdout, b); err != nil {
}
```

`Attachments` will extend the default `goldmark.Markdown` with custom link parser and image render function. The renderer can be configured with standard `html.Option`:
`Attachments` will extend the default `goldmark.Markdown` with a custom link parser and an image renderer. Quite naturally, this renderer accepts `html.Options` which can be passed to the constructor:

```go
import (
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d694010

Please sign in to comment.