Files
radicle-explorer/src/components/Markdown.svelte
T
Sebastian Martinez a6bc6d3c27 Fix small markdown spacing issue
Adds a listitem renderer overwrite to marked which
wraps everything that is inside a <li> which isn't only single <p> tag
into a <div class="list-content"> which we give a margin: 1rem 0;

Signed-off-by: Sebastian Martinez <me@sebastinez.dev>
2023-04-03 14:30:58 +02:00

315 lines
7.7 KiB
Svelte

<script lang="ts">
import dompurify from "dompurify";
import matter from "@radicle/gray-matter";
import { marked } from "marked";
import { onMount } from "svelte";
import { toDom } from "hast-util-to-dom";
import { base } from "@app/lib/router";
import { isUrl, twemoji, scrollIntoView, canonicalize } from "@app/lib/utils";
import { highlight } from "@app/lib/syntax";
import {
markdownExtensions as extensions,
renderer,
} from "@app/lib/markdown";
export let content: string;
export let hash: string | null = null;
export let path: string = "/";
export let breaks = false;
export let rawPath: string;
$: doc = matter(content);
$: frontMatter = Object.entries(doc.data).filter(
([, val]) => typeof val === "string" || typeof val === "number",
);
marked.use({ extensions, renderer, breaks });
let container: HTMLElement;
const render = (content: string): string =>
// eslint-disable-next-line @typescript-eslint/naming-convention
dompurify.sanitize(marked.parse(content), { SANITIZE_DOM: false });
onMount(async () => {
// Don't underline <a> tags that contain images.
for (const e of container.querySelectorAll("a")) {
if (e.firstElementChild instanceof HTMLImageElement) {
e.classList.add("no-underline");
}
}
if (hash) scrollIntoView(hash);
// Iterate over all images, and replace the source with a canonicalized URL
// pointing at the projects /raw endpoint.
for (const i of container.querySelectorAll("img")) {
const imagePath = i.getAttribute("src");
// Make sure the source isn't a URL before trying to fetch it from the repo
if (
imagePath &&
!isUrl(imagePath) &&
!imagePath.startsWith(`${base}twemoji`)
) {
i.setAttribute("src", `${rawPath}/${canonicalize(imagePath, path)}`);
}
}
// Replaces code blocks in the background with highlighted code.
const prefix = "language-";
const nodes = Array.from(document.body.querySelectorAll("pre code"));
const treeChanges: Promise<void>[] = [];
for (const node of nodes) {
const className = Array.from(node.classList).find(name =>
name.startsWith(prefix),
);
if (!className) continue;
treeChanges.push(
highlight(node.textContent ?? "", className.slice(prefix.length))
.then(tree => {
if (tree) {
node.replaceChildren(toDom(tree, { fragment: true }));
}
})
.catch(e => console.warn("Not able to highlight code block", e)),
);
}
await Promise.allSettled(treeChanges);
});
</script>
<style>
.front-matter {
font-size: var(--font-size-tiny);
font-family: var(--font-family-monospace);
color: var(--color-foreground);
border: 1px dashed var(--color-foreground-4);
padding: 0.5rem;
margin-bottom: 2rem;
}
.front-matter table {
border-collapse: collapse;
}
.front-matter table td {
padding: 0.125rem 1rem;
}
.front-matter table td:first-child {
padding-left: 0.5rem;
}
.markdown :global(h1),
.markdown :global(h2),
.markdown :global(h3),
.markdown :global(h4),
.markdown :global(h5),
.markdown :global(h6) {
color: var(--color-foreground);
}
.markdown :global(h1) {
font-size: calc(var(--font-size-x-large) * 0.75);
font-weight: var(--font-weight-medium);
padding: 1rem 0 0.5rem 0;
margin: 0 0 0.75rem;
border-bottom: 1px solid var(--color-foreground-4);
}
.markdown :global(h2) {
font-size: var(--font-size-medium);
font-weight: var(--font-weight-normal);
padding: 0.25rem 0;
margin: 2rem 0 0.5rem;
border-bottom: 1px dashed var(--color-foreground-4);
}
.markdown :global(h3) {
font-size: calc(var(--font-size-medium) * 0.9);
font-weight: var(--font-weight-medium);
padding: 0.5rem 0;
margin: 1rem 0 0.25rem;
}
.markdown :global(h4) {
font-weight: var(--font-weight-medium);
font-size: var(--font-size-regular);
padding: 0.5rem 0;
margin: 1rem 0 0.125rem;
}
.markdown :global(h5),
.markdown :global(h6) {
font-weight: var(--font-weight-medium);
font-size: var(--font-size-small);
padding: 0.35rem 0;
margin: 1rem 0 0.125rem;
}
.markdown :global(h6) {
color: var(--color-foreground-6);
}
.markdown :global(p) {
line-height: 1.625;
margin-top: 0;
margin-bottom: 0.625rem;
}
.markdown :global(p:last-child) {
margin-bottom: 0;
}
.markdown :global(blockquote) {
color: var(--color-foreground-6);
border-left: 0.3rem solid var(--color-foreground-4);
padding: 0 0 0 1rem;
margin: 1rem 0 1rem 0;
}
.markdown :global(strong) {
font-weight: var(--font-weight-medium);
}
.markdown :global(.footnote-ref > a),
.markdown :global(a.ref-arrow) {
border-bottom: none;
color: unset;
}
.markdown :global(img) {
border-style: none;
max-width: 100%;
}
.markdown :global(code) {
font-family: var(--font-family-monospace);
font-size: var(--font-size-regular);
color: var(--color-foreground-6);
background-color: var(--color-foreground-2);
border-radius: 0.5rem;
padding: 0.125rem 0.25rem;
}
.markdown :global(pre code) {
background: none;
padding: 0;
}
.markdown :global(pre) {
font-family: var(--font-family-monospace);
font-size: var(--font-size-regular);
background-color: var(--color-foreground-2);
padding: 1rem !important;
border-radius: var(--border-radius-small);
margin: 1rem 0;
overflow: scroll;
scrollbar-width: none;
}
.markdown :global(pre::-webkit-scrollbar) {
display: none;
}
.markdown :global(a),
.markdown :global(a > code) {
background: none;
padding: 0;
color: var(--color-foreground);
}
.markdown :global(a) {
text-decoration: none;
border-bottom: 1px solid var(--color-foreground-6);
}
.markdown :global(a.no-underline) {
border-bottom: none;
}
.markdown :global(hr) {
height: 0;
margin: 1rem 0;
overflow: hidden;
background: transparent;
border: 0;
border-bottom: 1px solid var(--color-foreground-4);
}
.markdown :global(ol) {
line-height: 1.625;
list-style-type: decimal;
margin-bottom: 1rem;
padding-left: 1.5rem;
}
.markdown :global(ul) {
line-height: 1.625;
list-style-type: inherit;
padding-left: 1.25rem;
margin-bottom: 1rem;
}
.markdown :global(.list-content) {
margin: 1rem 0;
}
.markdown :global(li > ul) {
margin-bottom: 0rem;
}
.markdown :global(li > ol) {
margin-bottom: 0rem;
}
.markdown :global(table) {
margin: 1.5rem 0;
border-collapse: collapse;
border-radius: 0.5rem;
border-style: hidden;
box-shadow: 0 0 0 1px var(--color-foreground-4);
overflow: hidden;
}
.markdown :global(td) {
text-align: left;
text-overflow: ellipsis;
border: 1px solid var(--color-foreground-4);
padding: 0.5rem 1rem;
}
.markdown :global(tr:nth-child(even)) {
background-color: var(--color-foreground-2);
}
.markdown :global(th) {
text-align: center;
padding: 0.5rem 1rem;
}
.markdown :global(*:first-child:not(pre)) {
padding-top: 0 !important;
}
.markdown :global(*:first-child) {
margin-top: 0 !important;
}
.markdown :global(dl dt) {
font-style: italic;
margin-top: 1rem;
}
.markdown :global(dl dd) {
margin: 0 0 0 2rem;
}
</style>
{#if frontMatter.length > 0}
<div class="front-matter">
<table>
{#each frontMatter as [key, val]}
<tr>
<td><span class="txt-bold">{key}</span></td>
<td>{val}</td>
</tr>
{/each}
</table>
</div>
{/if}
<div class="markdown" bind:this={container} use:twemoji={{ exclude: ["21a9"] }}>
{@html render(doc.content)}
</div>