comark-github
Write > [!NOTE], @user,
Note
Drafts save every few seconds, so closing the tab keeps your work.
Tip
Press ⌘K to search every document.
Important
Releases ship from main only.
Warning
Changing the slug breaks links people already shared.
Caution
Deleting a folder deletes every document in it.
> [!NOTE]
> Drafts save every few seconds, so closing the tab keeps your work.
> [!TIP]
> Press ⌘K to search every document.
> [!IMPORTANT]
> Releases ship from `main` only.
> [!WARNING]
> Changing the slug breaks links people already shared.
> [!CAUTION]
> Deleting a folder deletes every document in it.Decision
Keep the existing endpoint. Clients pin its response shape.
> [!IMPORTANT] Decision
> Keep the existing endpoint. Clients pin its response shape.Breaking change in v2
render(markdown) is gone. Create a renderer once instead:
- pass it your
pluginsandcomponents - key
componentsby tag name
const render = createHtmlRenderer({ plugins, components });> [!WARNING] Breaking change in v2
> `render(markdown)` is gone. Create a renderer once instead:
>
> - pass it your `plugins` and `components`
> - key `components` by tag name
>
> ```ts
> const render = createHtmlRenderer({ plugins, components });
> ```Thanks @onmax: this fixes #51, and onmax/comark-plugins#73 builds on it.
Thanks @onmax: this fixes #51, and onmax/comark-plugins#73 builds on it.Press ⌘ K to search. Water is H2O.
Where did the script go?
The source has a<script> after this sentence. GitHub drops it, and so does html(). Press <kbd>⌘</kbd> <kbd>K</kbd> to search. Water is H<sub>2</sub>O.
<img src="/dashboard.png" width="480" alt="Office correlations: ducks vs. bugs, r = 0.94">
<details>
<summary>Where did the script go?</summary>
The source has a <code><script></code> after this sentence. GitHub drops it, and so does <code>html()</code>. <script>alert("hi")</script>
</details>Three plugins, each one on its own:
callouts()draws GitHub's five alerts with an icon, a color, and a title. Text after the marker on its line replaces the title. Comark's built-in alert plugin only tags the quote with its type and leaves the drawing to you.references({ repo })links@userto the profile and#123orowner/name#123to the issue or pull request, as GitHub does in comments.html()renders raw HTML the way GitHub does: its tags and attributes stay, scripts and anything else it doesn't allow go. Comark renders all raw HTML as written.