pantsdown 1.7.1 → 1.7.2

package/README.md

@@ -11,9 +11,9 @@ some features developed specifically for [github-preview.nvim](https://github.co
 If you need a feature that's supported by GitHub and is not already listed in the [Roadmap](#roadmap),
 feel free to open an issue.
 
-### [Demo](https://wallpants.github.io/pantsdown/)
+### ▶️ [Demo](https://wallpants.github.io/pantsdown/)
 
-## Installation
+## 📦 Installation
 
 🚨 Pantsdown is distributed only as a TypeScript module. This means you'll need a bundler to handle transpilation.
 See below for usage examples.
@@ -25,7 +25,7 @@ bun install pantsdown
 npm install pantsdown
 ```
 
-## Usage
+## 💻 Usage
 
 ### Styles
 
@@ -79,7 +79,7 @@ function App() {
         if (container) container.innerHTML = html;
     }, []);
 
-    // 🚨 for styles to be applied, a parent element must have
+    // ⚠️ for styles to be applied, a parent element must have
     // the classes "pantsdown light" or "pantsdown dark" added
     return <div id="markdown-container" className="pantsdown light" />;
 }
@@ -87,7 +87,7 @@ function App() {
 export default App;
 ```
 
-## Configuration
+## ⚙️ Configuration
 
 The Pantsdown constructor accepts an optional configuration object:
 
@@ -129,6 +129,18 @@ const html = pantsdown.parse(markdown);
 console.log(html);
 ```
 
-## Roadmap
+## 🤝 Acknowledgements
 
+<a href="https://marked.js.org">
+  <img width="60px" height="60px" src="https://marked.js.org/img/logo-black.svg" align="right" />
+</a>
+
+Pantsdown is based on [Marked](https://github.com/markedjs/marked).
+Without their hard work, Pantsdown would not exist.
+
+## 🚀 Roadmap
+
+-   [ ] check if copy code button works with current vite docs
+-   [ ] showcase more in demo | list features
+-   [ ] [Alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)
 -   [ ] [Mermaid](https://mermaid.js.org/) usage docs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pantsdown",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "author": "wallpants",
   "description": "Markdown to 'GitHub HTML' parser",
   "license": "MIT",

package/src/rules/block.ts

@@ -111,10 +111,6 @@ const block_blockquote = edit(/^( {0,3}> ?(paragraph|[^\n]*)(?:\n|$))+/)
     .replace("paragraph", block_paragraph)
     .getRegex();
 
-const block_footnote = edit(/^( {0,3}\[\^(\d+)\]:(?:[ \t]+|[\n]*?|$)?(paragraph|[^\n]*))+/)
-    .replace("paragraph", block_paragraph)
-    .getRegex();
-
 export const block: Record<BlockRuleNames, RegExp> = {
     newline: /^(?: *(?:\n|$))+/,
     code: /^( {4}[^\n]+(?:\n(?: *(?:\n|$))*)?)+/,
@@ -130,6 +126,6 @@ export const block: Record<BlockRuleNames, RegExp> = {
     table: block_table,
     lheading: block_lheading,
     paragraph: block_paragraph,
-    footnote: block_footnote,
+    footnote: /^\[\^([^\]\n]+)\]:(?:[ \t]+|[\n]*?|$)([^\[\n]*?(?:\n|$)(?:[\n]*?[ ]{4,}[^\[\n]*)*)/,
     text: /^[^\n]+/,
 };

package/src/tokenizer.ts

@@ -330,8 +330,8 @@ export class Tokenizer {
         const cap = block.footnote.exec(src);
         if (!cap) return undefined;
 
-        const label = cap[2] ?? "";
-        let text = cap[3] ? rtrim(cap[3].replace(/^ *[ \t]?/gm, ""), "\n") : "";
+        const label = cap[1] ?? "";
+        let text = cap[2] ? rtrim(cap[2].replace(/^ *[ \t]?/gm, ""), "\n") : "";
 
         text += `<a href="#footnote-ref-${encodeURIComponent(
             label,

package/src/utils.ts

@@ -98,6 +98,7 @@ export function fixLocalImageHref(
         return href;
     }
 
+    // TODO: do we need this?
     if (href.startsWith("/")) {
         // the URL is from root
         return href;