@threepenny/md2pdf 0.0.0-stage → 2.0.0

package/lib/wikilinks.js

@@ -0,0 +1,75 @@
+// Obsidian wikilinks and embeds. A link to another note can't go anywhere in a single PDF, so
+// [[Note]], [[Note|alias]] and [[Note#Heading]] render as plain text, the way Obsidian displays them;
+// only a same-note [[#Heading]] becomes a link. ![[image.png]] renders like ![](image.png), and other
+// embeds, which neither the CLI nor the website can read, become a labelled placeholder.
+
+const IMAGE = /\.(avif|bmp|gif|jpe?g|png|svg|webp)$/i;
+const FILE = /\.(3gp|canvas|flac|m4a|mkv|mov|mp3|mp4|ogg|ogv|pdf|wav|webm)$/i;
+// Obsidian's ![[image.png|300]] and ![[image.png|300x200]] set the image's size.
+const SIZE = /^(\d+)(?:x(\d+))?$/;
+
+export default function wikilinks(md, { slugify }) {
+  md.inline.ruler.before('link', 'wikilink', (state, silent) => {
+    // Silent mode skips over a link's text; a rule that consumes its [ reads as a nested link and
+    // breaks [see [[Note]]](url). A wikilink's brackets balance, so it can be skipped one character at a time.
+    if (silent) return false;
+    const { src, pos } = state;
+    const embed = src.charCodeAt(pos) === 0x21 /* ! */;
+    const start = pos + (embed ? 1 : 0);
+    if (!src.startsWith('[[', start)) return false;
+    const end = src.indexOf(']]', start + 2);
+    if (end < 0) return false;
+    const inner = src.slice(start + 2, end);
+    if (!inner.trim() || /[\n[\]]/.test(inner)) return false;
+    // [[1]](url) is an ordinary link whose text is [1]; AI assistants write citations that way.
+    if (src.charCodeAt(end + 2) === 0x28 /* ( */) return false;
+
+    // In tables the pipe is escaped, [[Note\|alias]]; markdown-it unescapes it only inside table cells.
+    const [, target, alias = ''] = inner.match(/^(.*?)(?:\\?\|(.*))?$/);
+    const [page, ...rest] = target.split('#').map((s) => s.trim());
+    // Block references (#^id) name no heading to show.
+    const headings = rest.filter((h) => h && !h.startsWith('^'));
+    const name = [page, ...headings].filter(Boolean).join(' > ') || target.trim();
+    const text = alias.trim() || name;
+    if (!name) return false;
+
+    if (embed && IMAGE.test(page)) image(state, page, alias.trim());
+    // The placeholder names what was left out; Obsidian doesn't show an embed's alias either.
+    else if (embed) {
+      state.push('wikilink_embed', 'span', 0).meta = { kind: FILE.test(page) ? 'file' : 'note', text: name };
+    } else if (!page && headings.length) {
+      state.push('link_open', 'a', 1).attrs = [['href', `#${headingId(state.md, headings.at(-1))}`]];
+      state.push('text', '', 0).content = text;
+      state.push('link_close', 'a', -1);
+    } else {
+      state.push('text', '', 0).content = text;
+    }
+    state.pos = end + 2;
+    return true;
+  });
+
+  // markdown-it-anchor slugs a heading's text after the typographer and emoji rules have run, so
+  // `A -- B` has the id a--b. Slug the same text it does.
+  const headingId = (md, heading) =>
+    slugify(md.parseInline(heading, {})[0].children
+      .filter((t) => t.type === 'text' || t.type === 'code_inline')
+      .map((t) => t.content)
+      .join(''));
+
+  md.renderer.rules.wikilink_embed = (tokens, idx) => {
+    const { kind, text } = tokens[idx].meta;
+    return `<span class="markdown-embed">Embedded ${kind}: ${md.utils.escapeHtml(text)}</span>`;
+  };
+}
+
+function image(state, path, alias) {
+  const href = state.md.normalizeLink(path);
+  const size = alias.match(SIZE);
+  const alt = new state.Token('text', '', 0);
+  alt.content = size ? path : alias || path;
+  const token = state.push('image', 'img', 0);
+  token.attrs = [['src', state.md.validateLink(href) ? href : ''], ['alt', '']];
+  if (size) token.attrs.push(['width', size[1]], ...(size[2] ? [['height', size[2]]] : []));
+  token.children = [alt];
+  token.content = alt.content;
+}

package/package.json

@@ -1,6 +1,44 @@
 {
   "name": "@threepenny/md2pdf",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "2.0.0",
+  "description": "Markdown to beautifully styled PDF: the renderer and macOS CLI behind md2pdf.me",
+  "type": "module",
+  "license": "MIT",
+  "author": "Threepenny Labs LLC",
+  "homepage": "https://md2pdf.me",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jbrecht/md2pdf.git"
+  },
+  "bin": {
+    "md2pdf": "bin/md2pdf.js"
+  },
+  "exports": {
+    ".": "./lib/render.js",
+    "./render": "./lib/render.js",
+    "./styles": "./lib/styles.js",
+    "./styles/*": "./styles/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "styles"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "node test/run.js",
+    "demo": "echo 'Open http://localhost:3900/demo/' && python3 -m http.server 3900 --bind 127.0.0.1"
+  },
+  "dependencies": {
+    "github-markdown-css": "5.9.0",
+    "highlight.js": "^11.12.0",
+    "markdown-it": "^15.0.2",
+    "markdown-it-anchor": "^10.0.0",
+    "markdown-it-emoji": "^3.1.0",
+    "markdown-it-footnote": "^4.0.0",
+    "markdown-it-task-lists": "^2.1.1"
+  }
+}

package/styles/academic.css

@@ -0,0 +1,396 @@
+/* Academic: a journal-article look, with Palatino, numbered sections, booktabs tables and numbered figures. */
+
+/* Variables a page can override, on .markdown-body itself: for all its documents, or for one with
+   <article class="markdown-body" style="--md2pdf-font-size: 12pt">. A value set on :root or another
+   ancestor doesn't reach the document. :where() gives these defaults no specificity, so the page's
+   rule wins wherever it comes. Every style uses the same names. */
+:where(.markdown-body) {
+  /* Size and spacing. --md2pdf-font-size is the body text size, an absolute length such as 11pt or 15px; headings and smaller text scale with
+     it. --md2pdf-leading scales each line height's excess over 1, and --md2pdf-space the vertical
+     gaps between blocks; both are 1 as designed. */
+  --md2pdf-font-size: 11pt;
+  --md2pdf-leading: 1;
+  --md2pdf-space: 1;
+  /* Colors: --md2pdf-background the document's background; --md2pdf-text body text; --md2pdf-muted
+     secondary text; --md2pdf-accent links and callouts; --md2pdf-rule rules and table lines. */
+  --md2pdf-background: #fff;
+  --md2pdf-text: #111;
+  --md2pdf-muted: #555;
+  --md2pdf-accent: #1b3a73;
+  --md2pdf-rule: #111;
+  /* Fonts: --md2pdf-font body text, --md2pdf-heading-font headings (the body font unless set),
+     --md2pdf-code-font code. */
+  --md2pdf-font: Palatino, "Palatino Linotype", "Book Antiqua", "URW Palladio L", "TeX Gyre Pagella", Georgia, serif;
+  --md2pdf-heading-font: var(--md2pdf-font);
+  --md2pdf-code-font: "SF Mono", Menlo, Consolas, "Liberation Mono", monospace;
+}
+
+.markdown-body {
+  font-family: var(--md2pdf-font);
+  background: var(--md2pdf-background);
+  font-size: var(--md2pdf-font-size);
+  line-height: calc(1 + 0.42 * var(--md2pdf-leading));
+  color: var(--md2pdf-text);
+  font-kerning: normal;
+  counter-reset: h2 figure;
+  -webkit-print-color-adjust: exact;
+  print-color-adjust: exact;
+}
+
+.markdown-body p,
+.markdown-body li {
+  text-align: justify;
+  hyphens: auto;
+  orphans: 2;
+  widows: 2;
+}
+
+.markdown-body p {
+  margin: 0 0 calc(0.6em * var(--md2pdf-space));
+}
+/* Paragraphs that follow one another are indented rather than spaced, as in print. */
+.markdown-body p + p {
+  margin-top: calc(-0.6em * var(--md2pdf-space));
+  text-indent: 1.5em;
+}
+
+/* Headings: the first h1 is the title; h2–h4 are numbered 1, 1.1, 1.1.1. */
+
+.markdown-body h1,
+.markdown-body h2,
+.markdown-body h3,
+.markdown-body h4,
+.markdown-body h5,
+.markdown-body h6 {
+  font-family: var(--md2pdf-heading-font);
+  font-weight: bold;
+  line-height: calc(1 + 0.25 * var(--md2pdf-leading));
+  break-after: avoid;
+}
+
+.markdown-body h1 {
+  font-size: calc(17 / 11 * var(--md2pdf-font-size));
+  font-weight: normal;
+  text-align: center;
+  margin: 0 0 calc(1.5em * var(--md2pdf-space));
+}
+.markdown-body h1:not(:first-child) {
+  margin-top: calc(2em * var(--md2pdf-space));
+}
+
+.markdown-body h2 {
+  font-size: calc(13 / 11 * var(--md2pdf-font-size));
+  margin: calc(1.6em * var(--md2pdf-space)) 0 calc(0.6em * var(--md2pdf-space));
+  counter-increment: h2;
+  counter-reset: h3;
+}
+.markdown-body h3 {
+  font-size: calc(11.5 / 11 * var(--md2pdf-font-size));
+  margin: calc(1.3em * var(--md2pdf-space)) 0 calc(0.5em * var(--md2pdf-space));
+  counter-increment: h3;
+  counter-reset: h4;
+}
+.markdown-body h4 {
+  font-size: var(--md2pdf-font-size);
+  margin: calc(1.1em * var(--md2pdf-space)) 0 calc(0.4em * var(--md2pdf-space));
+  counter-increment: h4;
+}
+.markdown-body h5,
+.markdown-body h6 {
+  font-size: var(--md2pdf-font-size);
+  font-style: italic;
+  font-weight: normal;
+  margin: calc(1em * var(--md2pdf-space)) 0 calc(0.3em * var(--md2pdf-space));
+}
+.markdown-body h2::before {
+  content: counter(h2);
+  margin-right: 1em;
+}
+.markdown-body h3::before {
+  content: counter(h2) "." counter(h3);
+  margin-right: 1em;
+}
+.markdown-body h4::before {
+  content: counter(h2) "." counter(h3) "." counter(h4);
+  margin-right: 1em;
+}
+
+/* Links */
+
+.markdown-body a {
+  color: var(--md2pdf-accent);
+  text-decoration: none;
+}
+.markdown-body a.header-anchor {
+  display: none;
+}
+
+/* Lists */
+
+.markdown-body ul,
+.markdown-body ol {
+  margin: 0 0 calc(0.6em * var(--md2pdf-space));
+  padding-left: 1.8em;
+}
+.markdown-body li {
+  margin: calc(0.1em * var(--md2pdf-space)) 0;
+}
+.markdown-body li > p + p {
+  text-indent: 0;
+  margin-top: 0;
+}
+.markdown-body li > ul,
+.markdown-body li > ol {
+  margin: calc(0.1em * var(--md2pdf-space)) 0 0;
+}
+.markdown-body .task-list-item {
+  list-style-type: none;
+}
+.markdown-body .task-list-item input {
+  margin: 0 0.4em 0.2em -1.4em;
+  vertical-align: middle;
+  accent-color: var(--md2pdf-text);
+}
+
+/* Quotes: set in from both sides, slightly smaller. */
+
+.markdown-body blockquote {
+  margin: calc(0.9em * var(--md2pdf-space)) 2.2em;
+  padding: 0;
+  font-size: calc(10 / 11 * var(--md2pdf-font-size));
+  break-inside: avoid;
+}
+.markdown-body blockquote p + p {
+  text-indent: 0;
+  margin-top: 0;
+}
+
+/* Callouts (GitHub alerts and Obsidian callouts): set off by a thin rule, titled in small caps. */
+
+.markdown-body .markdown-alert {
+  --md2pdf-callout: var(--md2pdf-accent);
+  margin: calc(0.9em * var(--md2pdf-space)) 0;
+  padding: 0.1em 0 0.1em 1em;
+  border-left: 1.5px solid var(--md2pdf-callout);
+  break-inside: avoid;
+}
+.markdown-body .markdown-alert-tip {
+  --md2pdf-callout: #2f5a2a;
+}
+.markdown-body .markdown-alert-important {
+  --md2pdf-callout: #5a2f6b;
+}
+.markdown-body .markdown-alert-warning {
+  --md2pdf-callout: #7a5410;
+}
+.markdown-body .markdown-alert-caution {
+  --md2pdf-callout: #8a1f1f;
+}
+.markdown-body .markdown-alert-quote {
+  --md2pdf-callout: var(--md2pdf-muted);
+}
+.markdown-body .markdown-alert-title {
+  color: var(--md2pdf-callout);
+  font-variant: small-caps;
+  font-weight: bold;
+  letter-spacing: 0.03em;
+  text-align: left;
+  hyphens: manual;
+}
+.markdown-body .markdown-alert-title .octicon {
+  margin-right: 0.4em;
+  vertical-align: -0.1em;
+  width: 0.8em;
+  height: 0.8em;
+  fill: currentColor;
+}
+.markdown-body .markdown-alert-title + p {
+  text-indent: 0;
+}
+.markdown-body .markdown-alert > :last-child {
+  margin-bottom: 0;
+}
+
+/* Code */
+
+.markdown-body code,
+.markdown-body kbd {
+  font-family: var(--md2pdf-code-font);
+  font-size: 0.84em;
+}
+.markdown-body kbd {
+  padding: 0 0.3em;
+  border: 0.75px solid var(--md2pdf-muted);
+  border-radius: 2px;
+}
+.markdown-body pre {
+  margin: calc(0.9em * var(--md2pdf-space)) 0;
+  padding: 0.6em 0;
+  border-top: 0.75px solid var(--md2pdf-rule);
+  border-bottom: 0.75px solid var(--md2pdf-rule);
+  line-height: calc(1 + 0.4 * var(--md2pdf-leading));
+  white-space: pre-wrap;
+  word-break: break-word;
+  break-inside: avoid;
+}
+.markdown-body pre code {
+  font-size: calc(8.5 / 11 * var(--md2pdf-font-size));
+}
+/* A highlight.js theme on the host page styles .hljs too; keep code blocks this style's own. */
+.markdown-body pre code.hljs {
+  display: inline;
+  overflow: visible;
+  padding: 0;
+  color: inherit;
+  background: none;
+}
+/* And its tokens: this outranks a theme's token rules, and this style's colors come after it. */
+.markdown-body [class*="hljs-"] {
+  color: inherit;
+  background: none;
+  font-style: inherit;
+  font-weight: inherit;
+  text-decoration: none;
+}
+
+.markdown-body .hljs-comment,
+.markdown-body .hljs-quote {
+  color: #6b6b6b;
+  font-style: italic;
+}
+.markdown-body .hljs-keyword,
+.markdown-body .hljs-selector-tag,
+.markdown-body .hljs-literal,
+.markdown-body .hljs-doctag,
+.markdown-body .hljs-built_in {
+  color: #1b3a73;
+  font-weight: bold;
+}
+.markdown-body .hljs-string,
+.markdown-body .hljs-regexp,
+.markdown-body .hljs-addition {
+  color: #3d5a2a;
+}
+.markdown-body .hljs-number,
+.markdown-body .hljs-symbol,
+.markdown-body .hljs-bullet,
+.markdown-body .hljs-meta,
+.markdown-body .hljs-deletion {
+  color: #7a3b1d;
+}
+.markdown-body .hljs-title,
+.markdown-body .hljs-section,
+.markdown-body .hljs-name,
+.markdown-body .hljs-type {
+  color: #111;
+  font-weight: bold;
+}
+.markdown-body .hljs-emphasis {
+  font-style: italic;
+}
+.markdown-body .hljs-strong {
+  font-weight: bold;
+}
+
+/* Math: a touch smaller than KaTeX's default so formulas sit evenly with Palatino. */
+
+.markdown-body .katex {
+  font-size: 1.1em;
+}
+.markdown-body .katex-display {
+  margin: calc(0.8em * var(--md2pdf-space)) 0;
+}
+
+/* Tables: booktabs-style rules, no vertical lines. */
+
+.markdown-body table {
+  border-collapse: collapse;
+  margin: calc(1.1em * var(--md2pdf-space)) auto;
+  border-top: 1.2px solid var(--md2pdf-rule);
+  border-bottom: 1.2px solid var(--md2pdf-rule);
+  font-size: calc(10 / 11 * var(--md2pdf-font-size));
+  font-variant-numeric: lining-nums tabular-nums;
+}
+.markdown-body th,
+.markdown-body td {
+  padding: 0.3em 0.8em;
+  text-align: left;
+}
+.markdown-body th {
+  font-weight: normal;
+  border-bottom: 0.6px solid var(--md2pdf-rule);
+}
+.markdown-body tr {
+  break-inside: avoid;
+}
+
+/* Figures: diagrams are numbered, so the text can refer to "Figure 2". */
+
+.markdown-body .mermaid-diagram {
+  margin: calc(1.2em * var(--md2pdf-space)) 0;
+  counter-increment: figure;
+}
+.markdown-body .mermaid-diagram::after {
+  content: "Figure " counter(figure) ".";
+  display: block;
+  margin-top: calc(0.5em * var(--md2pdf-space));
+  font-family: var(--md2pdf-font);
+  font-size: calc(10 / 11 * var(--md2pdf-font-size));
+}
+
+.markdown-body img {
+  display: block;
+  max-width: 100%;
+  margin: calc(1em * var(--md2pdf-space)) auto;
+  break-inside: avoid;
+}
+
+.markdown-body hr {
+  width: 30%;
+  margin: calc(1.4em * var(--md2pdf-space)) auto;
+  border: 0;
+  border-top: 0.75px solid var(--md2pdf-rule);
+}
+
+/* Footnotes: small type under a short rule, as in a journal. */
+
+.markdown-body hr.footnotes-sep {
+  display: none;
+}
+.markdown-body .footnotes {
+  margin-top: calc(2.2em * var(--md2pdf-space));
+  font-size: calc(9 / 11 * var(--md2pdf-font-size));
+  line-height: calc(1 + 0.35 * var(--md2pdf-leading));
+}
+.markdown-body .footnotes::before {
+  content: "";
+  display: block;
+  width: 25%;
+  border-top: 0.6px solid var(--md2pdf-rule);
+  margin-bottom: calc(0.7em * var(--md2pdf-space));
+}
+.markdown-body .footnotes ol {
+  padding-left: 1.4em;
+}
+.markdown-body .footnotes p + p {
+  text-indent: 0;
+  margin-top: 0;
+}
+.markdown-body .footnote-ref a {
+  color: var(--md2pdf-text);
+}
+/* "Back to text" arrows are for screens. */
+.markdown-body .footnote-backref {
+  display: none;
+}
+
+/* An Obsidian embed (![[Other note]]) that can't be shown: a muted placeholder. */
+.markdown-body .markdown-embed {
+  color: var(--md2pdf-muted);
+  font-style: italic;
+}
+
+/* <div class="page-break"></div> starts a new page. */
+.markdown-body .page-break {
+  break-after: page;
+}