panda-editor 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b8232a60a069137aa8a04c6611f0583877cf036ba6c62c82bef72584c5216d
-  data.tar.gz: 975f2cb5e0fb8ce6eaa5ae8eb80e3135e1ff44126c102271dd318b148b40b47a
+  metadata.gz: 148f84007d3e1e31886f6be8297edfd19f5ddc13e29d1ff565d66a7c27261f85
+  data.tar.gz: 0e2794c6183a16940bdd62c62ff0f63e6b55c0e529adb025e596f93041de565f
 SHA512:
-  metadata.gz: a012d400a6af140737018adb0187ce7e54be0614d1fd833492cebb35d4310aac91eeab2109ab8d08857333226624084d2ada8a567c21ff8ea43fff018ca17c0c
-  data.tar.gz: 8df13bfa16acea6e9e65b22e20ff3e138791648c654090d1134140fa94b1bea7b8d439ef8544a73c9c7ac5ad8066539e9eca1842e8f152d86e3634b65bb71c73
+  metadata.gz: 06cef5d5517ef1211bcfc1b0b5c0c63dba5c8bfd9d189b1074e1174d261d14de5d15c522734cdc69fca71c3ef3cfbbed88fe741de6e739a4c9b49a4a7960219d
+  data.tar.gz: c169a830348145a9b9f24a62d15333a02fb9b27cc0bdc2356a383ade82010af16369e2279034bae78607ff751844c52a417d872a0146023445bcf7c4d7dc29b8

data/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2025-10-30
+
+### Added
+- Markdown support for rich text formatting in footnotes
+  - **Bold**, *italic*, `code`, ~~strikethrough~~, and [link](url) support
+  - Automatic URL linking in markdown content
+  - Security-hardened Redcarpet configuration (no images, safe links only)
+  - Works alongside existing autolink_urls option
+  - Comprehensive test coverage for markdown features
+  - Updated documentation with markdown examples
+
 ## [0.3.0] - 2025-10-30
 
 ### Added

data/README.md

@@ -168,6 +168,27 @@ The sources section includes data attributes for integration with JavaScript fra
 
 See [docs/FOOTNOTES.md](docs/FOOTNOTES.md) for detailed implementation examples.
 
+### Markdown Support
+
+Enable markdown formatting in footnote content for rich text citations:
+
+```ruby
+renderer = Panda::Editor::Renderer.new(@content, markdown: true)
+html = renderer.render
+```
+
+Supports **bold**, *italic*, `code`, ~~strikethrough~~, and [links](url):
+
+**Input:**
+```
+Smith, J. (2023). **Important study** on *ADHD treatment*. See https://example.com for details.
+```
+
+**Output:**
+```html
+Smith, J. (2023). <strong>Important study</strong> on <em>ADHD treatment</em>. See <a href="https://example.com" target="_blank" rel="noopener noreferrer">https://example.com</a> for details.
+```
+
 ### Auto-linking URLs
 
 Enable automatic URL linking in footnote content:
@@ -195,6 +216,9 @@ Features:
 - Won't double-link URLs already in `<a>` tags
 - Supports `http://`, `https://`, `ftp://`, and `www.` URLs
 - Handles multiple URLs in the same footnote
+- Can be combined with `markdown: true` (markdown's autolink runs first, then custom autolink for any remaining URLs)
+
+**Note:** When using `markdown: true`, you typically don't need `autolink_urls: true` as markdown includes built-in autolinking. However, both options can work together safely.
 
 To enable globally for all content using the `Panda::Editor::Content` concern, pass the option in `generate_cached_content`.
 

data/docs/FOOTNOTES.md

@@ -308,9 +308,58 @@ insert at position 11: "Hello world<sup>2</sup>"
 insert at position 5: "Hello<sup>1</sup> world<sup>2</sup>"
 ```
 
+### Markdown Support
+
+The footnote system supports markdown formatting, allowing you to use rich text formatting in your citations.
+
+**Enable markdown:**
+
+```ruby
+renderer = Panda::Editor::Renderer.new(content, markdown: true)
+output = renderer.render
+```
+
+**Supported markdown features:**
+
+- **Bold text** (`**bold**` or `__bold__`)
+- *Italic text* (`*italic*` or `_italic_`)
+- `Inline code` (`` `code` ``)
+- ~~Strikethrough~~ (`~~text~~`)
+- [Links](url) (`[text](url)`)
+- Automatic URL linking
+
+**Example:**
+
+```ruby
+content = {
+  "blocks" => [{
+    "type" => "paragraph",
+    "data" => {
+      "text" => "Research findings",
+      "footnotes" => [{
+        "id" => "fn-1",
+        "content" => "Smith, J. (2023). **Important study** on *ADHD treatment*. See https://example.com for details.",
+        "position" => 17
+      }]
+    }
+  }]
+}
+
+renderer = Panda::Editor::Renderer.new(content, markdown: true)
+# Output will include: Smith, J. (2023). <strong>Important study</strong> on <em>ADHD treatment</em>. See <a href="https://example.com">https://example.com</a> for details.
+```
+
+**Important notes:**
+
+- Markdown includes built-in URL autolinking, so you typically don't need `autolink_urls: true` when using markdown
+- However, both options can be used together if needed - the custom autolink_urls will skip URLs that markdown already linked
+- Markdown links are rendered with `target="_blank"` and `rel="noopener noreferrer"` for security
+- Images are disabled in markdown footnotes for security
+- HTML styles are stripped from markdown output
+
 ### Auto-linking URLs
 
-The footnote system can automatically convert plain URLs in footnote content into clickable links.
+The footnote system can automatically convert plain URLs in footnote content into clickable links when markdown is not enabled.
 
 **Enable auto-linking:**
 
@@ -575,7 +624,7 @@ bundle exec rspec spec/lib/panda/editor/renderer_spec.rb
 Potential improvements for future versions:
 
 - [ ] Support for footnotes in other block types (headers, quotes, etc.)
-- [ ] Rich text formatting within footnote content
+- [x] Rich text formatting within footnote content (implemented via markdown support)
 - [ ] Footnote tooltips on hover
 - [ ] Customizable footnote markers (*, †, ‡, etc.)
 - [ ] Export footnotes to bibliography formats (BibTeX, etc.)

data/lib/panda/editor/footnote_registry.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
+require "redcarpet"
+
 module Panda
   module Editor
     class FootnoteRegistry
       attr_reader :footnotes
 
-      def initialize(autolink_urls: false)
+      def initialize(autolink_urls: false, markdown: false)
         @footnotes = []
         @footnote_ids = {}
         @autolink_urls = autolink_urls
+        @markdown = markdown
       end
 
       def add(id:, content:)
@@ -30,7 +33,7 @@ module Panda
 
         footnote_items = @footnotes.map.with_index do |footnote, index|
           number = index + 1
-          content = @autolink_urls ? autolink_urls(footnote[:content]) : footnote[:content]
+          content = process_content(footnote[:content])
           <<~HTML.strip
             <li id="fn:#{number}">
               <p>
@@ -66,6 +69,45 @@ module Panda
 
       private
 
+      def process_content(content)
+        # Apply markdown processing if enabled
+        content = render_markdown(content) if @markdown
+
+        # Apply URL autolinking if enabled
+        # Note: Markdown already includes autolink, but custom autolink_urls can still be used
+        # if needed for additional URL patterns. The autolink_urls method skips already-linked URLs.
+        content = autolink_urls(content) if @autolink_urls
+
+        content
+      end
+
+      def render_markdown(text)
+        # Configure Redcarpet with safe options for footnotes
+        renderer = Redcarpet::Render::HTML.new(
+          filter_html: false,
+          no_images: true,
+          no_styles: true,
+          safe_links_only: true,
+          link_attributes: {target: "_blank", rel: "noopener noreferrer"}
+        )
+
+        markdown = Redcarpet::Markdown.new(
+          renderer,
+          autolink: true,
+          space_after_headers: true,
+          fenced_code_blocks: false,
+          no_intra_emphasis: true,
+          strikethrough: true,
+          superscript: false,
+          underline: false
+        )
+
+        # Render markdown and strip the wrapping <p> tags if present
+        # since we're already wrapping in <p> tags in the template
+        html = markdown.render(text).strip
+        html.gsub(%r{^<p>(.*)</p>$}m, '\1')
+      end
+
       def autolink_urls(text)
         # Regex to match URLs that aren't already in <a> tags
         # Matches http://, https://, and other common protocols

data/lib/panda/editor/renderer.rb

@@ -14,7 +14,8 @@ module Panda
         @cache_store = options.delete(:cache_store) || Rails.cache
         @validate_html = options.delete(:validate_html) || false
         autolink_urls = options.delete(:autolink_urls) || false
-        @footnote_registry = FootnoteRegistry.new(autolink_urls: autolink_urls)
+        markdown = options.delete(:markdown) || false
+        @footnote_registry = FootnoteRegistry.new(autolink_urls: autolink_urls, markdown: markdown)
         @options[:footnote_registry] = @footnote_registry
       end
 

data/lib/panda/editor/version.rb

@@ -2,6 +2,6 @@
 
 module Panda
   module Editor
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/panda-editor.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rails", ">= 7.1"
   spec.add_dependency "sanitize", "~> 6.0"
   spec.add_dependency "dry-configurable", "~> 1.0"
+  spec.add_dependency "redcarpet", "~> 3.6"
 
   # Development dependencies
   spec.add_development_dependency "rspec-rails", "~> 6.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panda-editor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Otaina Limited
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement