pantsdown 1.3.1 → 1.4.1

package/LICENSE

@@ -0,0 +1,136 @@
+Pantsdown (https://github.com/wallpants/pantsdown)
+
+Copyright (c) 2023+, Wallpants (https://github.com/wallpants/).
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+----------------------------------------------------
+
+highlight.js (https://github.com/highlightjs/highlight.js)
+
+BSD 3-Clause License
+
+Copyright (c) 2006, Ivan Sagalaev.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+----------------------------------------------------
+
+github-markdown-css (https://github.com/sindresorhus/github-markdown-css)
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+----------------------------------------------------
+
+Marked
+
+Copyright (c) 2018+, MarkedJS (https://github.com/markedjs/)
+
+Copyright (c) 2011-2018, Christopher Jeffrey (https://github.com/chjj/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+----------------------------------------------------
+
+Markdown
+
+Copyright © 2004, John Gruber
+http://daringfireball.net/
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+-   Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+-   Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+-   Neither the name “Markdown” nor the names of its contributors may be used
+    to endorse or promote products derived from this software without specific
+    prior written permission.
+
+This software is provided by the copyright holders and contributors “as is”
+and any express or implied warranties, including, but not limited to,
+the implied warranties of merchantability and fitness for a particular purpose
+are disclaimed. In no event shall the copyright owner or contributors be liable
+for any direct, indirect, incidental, special, exemplary, or consequential
+damages (including, but not limited to, procurement of substitute goods or
+services; loss of use, data, or profits; or business interruption) however
+caused and on any theory of liability, whether in contract, strict liability,
+or tort (including negligence or otherwise) arising in any way out of the use
+of this software, even if advised of the possibility of such damage.

package/README.md

@@ -1,5 +1,110 @@
+<!-- Up to marked@9.1.2 -->
+
 # Pantsdown
 
-<!-- Up to https://github.com/markedjs/marked/commit/f90ae0692c772fee55182216b7158f4df5b37bb9 -->
+Pantsdown is a **Markdown** to **"GitHub HTML"** converter based on [Marked](https://github.com/markedjs/marked).
+Basically this is a non customizable version of Marked, optimized to render markdown similar to how GitHub does it plus
+some features developed specifically for [github-preview.nvim](https://github.com/wallpants/github-preview.nvim).
+
+Applicable fixes/updates released by Marked will eventually be applied to Pantsdown.
+
+If you need a feature that's supported by GitHub and is not already listed in Pantsdown's [Roadmap](#roadmap),
+feel free to open an issue. If you need anything else, use Marked or another library.
+
+## Installation
+
+🚨 Pantsdown is distributed only as a TypeScript module. This means you'll need a bundler to handle transpilation.
+See below for usage examples.
+
+```sh
+bun install pantsdown
+```
+
+## Usage
+
+### [Vite](https://vitejs.dev/guide/#scaffolding-your-first-vite-project)
+
+Create a Vite Project & install dependencies:
+
+```sh
+bun create vite my-app --template react-swc-ts
+cd my-app
+bun install pantsdown
+```
+
+Remove CSS from `my-app/src/main.tsx`:
+
+```diff
+import React from 'react'
+import ReactDOM from 'react-dom/client'
+import App from './App.tsx'
+- import './index.css'
+
+ReactDOM.createRoot(document.getElementById('root')!).render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>,
+)
+```
+
+Replace content in `my-app/src/App.tsx`:
+
+```tsx
+import { Pantsdown } from "pantsdown";
+import "pantsdown/styles.css";
+import { useEffect } from "react";
+
+const pantsdown = new Pantsdown();
+
+function App() {
+    useEffect(() => {
+        const markdown = "# Hello world\n- [ ] item 1\n- [ ] item 2";
+        const html = pantsdown.parse(markdown);
+        const container = document.getElementById("markdown-container");
+        if (container) container.innerHTML = html;
+    }, []);
+
+    return <div id="markdown-container" className="pantsdown light" />;
+}
+
+export default App;
+```
+
+## Configuration
+
+The Pantsdown constructor accepts an optional configuration object:
+
+```typescript
+import { PantsdownConfig } from "pantsdown";
+
+const config: PantsdownConfig = {
+    renderer: {
+        /**
+         * Prefix to be added to relative image sources.
+         * Must start and end with "/"
+         *
+         * @example
+         * relativeImageUrlPrefix: "/__localimage__/"
+         *
+         * ![image](./wallpants-512.png)
+         * relative src is updated and result in:
+         * <img src="/__localimage__/wallpants-512.png" />
+         *
+         * ![image](https://avatars.githubusercontent.com/wallpants)
+         * absolute path remains unchanged:
+         * <img src="https://avatars.githubusercontent.com/wallpants" />
+         */
+        relativeImageUrlPrefix: "/__localimage__/",
+    },
+};
+
+const pantsdown = new Pantsdown(config);
+pantsdown.parse(markdown);
+```
+
+## Roadmap
 
-The Markdown parser.
+-   [x] Add id & anchors to headings
+-   [ ] Add button to copy code in fences
+-   [ ] [Mermaid](https://mermaid.js.org/) support
+-   [ ] [Footnote](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#footnotes) support [Base](https://github.com/bent10/marked-extensions/tree/main/packages/footnote)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pantsdown",
-  "version": "1.3.1",
+  "version": "1.4.1",
   "author": "wallpants",
   "description": "The markdown parser",
   "license": "MIT",
@@ -11,9 +11,9 @@
   },
   "exports": {
     "./styles.css": {
-      "types": "./styles.css.d.ts",
-      "bun": "./styles.css",
-      "import": "./styles.css"
+      "types": "./src/css/styles.css.d.ts",
+      "bun": "./src/css/styles.css",
+      "import": "./src/css/styles.css"
     },
     ".": {
       "types": "./src/index.ts",
@@ -37,6 +37,7 @@
     ]
   },
   "dependencies": {
+    "github-slugger": "^2.0.0",
     "highlight.js": "^11.9.0"
   },
   "devDependencies": {