@lowlighter/markdown 1.0.0 → 1.2.0

package/README.md

@@ -6,18 +6,63 @@
 - [`🦕 Playground`](https://libs.lecoq.io/markdown)
 - [`📚 Documentation`](https://jsr.io/@libs/markdown/doc)
 
+## 📑 Examples
+
+### Rendering markdown
+
+```ts
+// Render markdown using the default renderer
+import { Renderer } from "./renderer.ts"
+await Renderer.render("# Hello, world!")
+
+// Render markdown using a custom renderer
+import { gfm, highlighting, markers, math, sanitize, wikilinks } from "./plugins/mod.ts"
+const renderer = new Renderer({ plugins: [gfm, highlighting, math, markers, wikilinks, sanitize] })
+await renderer.render("# Hello, world!")
+```
+
+### Creating a custom renderer with different plugins sources
+
+```ts
+import { Renderer } from "./renderer.ts"
+import frontmatter from "./plugins/frontmatter.ts"
+
+const renderer = await Renderer.with({
+  plugins: [
+    // You can specify an existing Plugin object...
+    frontmatter,
+    // ...or a a HTTPS import that points towards a compatible Plugin object!
+    "https://esm.sh/jsr/@libs/markdown/plugins/gfm",
+  ],
+})
+await renderer.render("# foo")
+```
+
 ## ✨ Features
 
 - Render markdown to HTML using the [unified ecosystem](https://unifiedjs.com).
 - Straightforward API for both basic markdown and extended markdown rendering
 - Support out-of-the-box dozen of plugins to add extended markdown features
-  - Headings anchors
-  - Frontmatter
-  - Code highlighting
-  - Math
-  - Mermaid diagrams
-  - Wiki links
+  - [Headings anchors](https://jsr.io/@libs/markdown/doc/plugins/anchors/~/default)
+  - [Custom directives](https://jsr.io/@libs/markdown/doc/plugins/directives/~/default)
+  - [Emoji rendering](https://jsr.io/@libs/markdown/doc/plugins/emojis/~/default)
+  - [Frontmatter parsing](https://jsr.io/@libs/markdown/doc/plugins/frontmatter/~/default)
+  - [GitHub Flavored Markdown](https://jsr.io/@libs/markdown/doc/plugins/gfm/~/default)
+  - [Code highlighting](https://jsr.io/@libs/markdown/doc/plugins/highlighting/~/default)
+  - [Linebreaks](https://jsr.io/@libs/markdown/doc/plugins/linebreaks/~/default)
+  - [Markers](https://jsr.io/@libs/markdown/doc/plugins/markers/~/default)
+  - [Math rendering](https://jsr.io/@libs/markdown/doc/plugins/math/~/default)
+  - [Mermaid diagrams](https://jsr.io/@libs/markdown/doc/plugins/mermaid/~/default)
+  - [Ruby annotations](https://jsr.io/@libs/markdown/doc/plugins/ruby/~/default)
+  - [HTML sanitization](https://jsr.io/@libs/markdown/doc/plugins/sanitize/~/default)
+  - [Comment removal](https://jsr.io/@libs/markdown/doc/plugins/uncomments/~/default)
+  - [Wiki links](https://jsr.io/@libs/markdown/doc/plugins/wikilinks/~/default)
   - etc.
+- Plugins can be imported:
+  - From already existing Plugin objects
+  - From local sources
+  - From remote HTTPS sources
+    - The last option is particularly useful for user-provided customizations in a dynamic environment.
 
 ## 📜 Licenses and credits
 

package/deno.jsonc

@@ -1,7 +1,7 @@
 {
   "icon": "🖨️",
   "name": "@libs/markdown",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Markdown renderer with optional plugins based on the unified ecosystem.",
   "keywords": [
     "markdown",
@@ -28,17 +28,20 @@
   "exports": {
     ".": "./mod.ts",
     "./renderer": "./renderer.ts",
+    "./plugins": "./plugins/mod.ts",
     "./plugins/anchors": "./plugins/anchors.ts",
-    "./plugins/highlighting": "./plugins/highlighting.ts",
     "./plugins/directives": "./plugins/directives.ts",
     "./plugins/emojis": "./plugins/emojis.ts",
     "./plugins/frontmatter": "./plugins/frontmatter.ts",
     "./plugins/gfm": "./plugins/gfm.ts",
+    "./plugins/highlighting": "./plugins/highlighting.ts",
     "./plugins/linebreaks": "./plugins/linebreaks.ts",
     "./plugins/markers": "./plugins/markers.ts",
-    "./plugins/uncomments": "./plugins/uncomments.ts",
+    "./plugins/math": "./plugins/math.ts",
+    "./plugins/mermaid": "./plugins/mermaid.ts",
     "./plugins/ruby": "./plugins/ruby.ts",
     "./plugins/sanitize": "./plugins/sanitize.ts",
+    "./plugins/uncomments": "./plugins/uncomments.ts",
     "./plugins/wikilinks": "./plugins/wikilinks.ts"
   },
   "imports": {
@@ -81,12 +84,14 @@
   "tasks": {
     "build": "npx playwright-core install --with-deps chromium",
     "test": "deno test --allow-read --allow-env --allow-write --allow-sys --allow-run --no-prompt --coverage --clean --trace-leaks --doc",
-    "test:deno": "deno fmt --check && deno task test --filter='/^\\[deno\\]/' --quiet && deno coverage --exclude=.js && deno lint",
-    "test:deno-future": "DENO_FUTURE=1 && deno task test:deno",
-    "test:others": "deno fmt --check && deno task test --filter='/^\\[node|bun \\]/' --quiet && deno coverage --exclude=.js && deno lint",
+    "test:deno": "deno task clean:deno && deno fmt --check && deno task test --filter='/^\\[deno\\]/' --quiet && deno coverage --exclude=.js && deno lint",
+    "test:deno-future": "deno task clean:deno && DENO_FUTURE=1 && deno task test:deno",
+    "test:others": "deno task clean:others && deno fmt --check && deno task test --filter='/^\\[node|bun \\]/' --quiet && deno coverage --exclude=.js && deno lint",
     "coverage:html": "deno task test --filter='/^\\[deno\\]/' --quiet && deno coverage --exclude=.js --html && sleep 1",
     "dev": "deno fmt && deno task test --filter='/^\\[deno\\]/' && deno coverage --exclude=.js --detailed && deno task lint",
-    "lint": "deno fmt --check && deno lint && deno doc --lint mod.ts && deno publish --dry-run --quiet --allow-dirty"
+    "lint": "deno fmt --check && deno lint && deno doc --lint mod.ts && deno publish --dry-run --quiet --allow-dirty",
+    "clean:deno": "rm -rf node_modules .npmrc deno.lock",
+    "clean:others": "rm -rf node_modules .npmrc deno.lock package.json package-lock.json bun.lockb"
   },
   "lint": {
     "rules": {