ldown 0.0.1

data/ext/ldown/ldown.h

@@ -0,0 +1,6 @@
+#ifndef LDOWN_H
+#define LDOWN_H 1
+
+#include "ruby.h"
+
+#endif /* LDOWN_H */

data/lib/ldown/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ldown
+  VERSION = "0.0.1"
+end

data/lib/ldown.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+#---
+# Copyright (C) 2026  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#+++
+
+require_relative "ldown/version"
+require "ldown/ldown"
+
+# The all +into_+ class methods take a lot of keyword arguments as
+# shown in the type signatures.  Please also refer to the lowdown
+# manpages for the detailed explanations for them.
+module Ldown
+  class << self
+    ##
+    # :method: into_fodt
+    #
+    # Parse into the flat OpenDocument.
+
+    ##
+    # :method: into_gemini
+    #
+    # Parse into Gemtext (for Gemini protocol).
+
+    ##
+    # :method: into_man
+    #
+    # Parse into roff man.
+
+    ##
+    # :method: into_mdoc
+    #
+    # Parse into roff mdoc.
+
+    ##
+    # :method: into_ms
+    #
+    # Parse into roff ms.
+
+    ##
+    # :method: into_term
+    #
+    # Parse into the ANSI UTF-8 terminal output.
+
+    ##
+    # :method: into_tree
+    #
+    # Parse into the debug tree serialization.
+  end
+
+  class Document
+    class << self
+      ##
+      # :method: new
+      # :call-seq: new (**kwargs)
+      #
+      # It takes sum of options for the ones that
+      # <tt>Lowdown.into_*</tt> class methods take.
+    end
+
+    ##
+    # :method: parse
+    # :call-seq: parse (input) -> node
+  end
+
+  class Gemini
+    class << self
+      ##
+      # :method: new
+      # :call-seq: new (**kwargs)
+      #
+      # It takes the same options as +Ldown.into_gemini+.
+    end
+  end
+
+  class HTML
+    class << self
+      ##
+      # :method: new
+      # :call-seq: new (**kwargs)
+      #
+      # It takes the same options as +Ldown.into_html+.
+    end
+  end
+
+  class LaTeX
+    class << self
+      ##
+      # :method: new
+      # :call-seq: new (**kwargs)
+      #
+      # It takes the same options as +Ldown.into_latex+.
+    end
+  end
+
+  class OpenDocument
+    class << self
+      ##
+      # :method: new
+      # :call-seq: new (**kwargs)
+      #
+      # It takes the same options as +Ldown.into_fodt+.
+    end
+  end
+
+  class Roff
+    class << self
+      ##
+      # :method: new
+      # :call-seq: new (**kwargs)
+      #
+      # It takes the same options as +Ldown.into_man+,
+      # +Ldown.into_mdoc+, or +Ldown.into_ms+.
+    end
+  end
+
+  class Term
+    class << self
+      ##
+      # :method: new
+      # :call-seq: new (**kwargs)
+      #
+      # It takes the same options as +Ldown.into_term+.
+    end
+  end
+end

data/sig/ldown.rbs

@@ -0,0 +1,128 @@
+module Ldown
+  VERSION: String
+
+  def self.into_fodt: (
+    # feat:
+    attrs: bool, autolink: bool, callouts: bool, commonmark: bool, deflist: bool, fenced: bool, footnotes: bool, hilite: bool, mantitle: bool, math: bool, metadata: bool, no_code_indented: bool, no_intra_emph: bool, strike: bool, super: bool, super_short: bool, tables: bool, tasklist: bool,
+    # oflags/general:
+    no_link: bool, no_rellink: bool, shortlink: bool, skip_html: bool, smarty: bool, standalone: bool,
+    # others:
+    maxdepth: Integer) -> String
+
+  def self.into_gemini: (
+    # feat:
+    attrs: bool, autolink: bool, callouts: bool, commonmark: bool, deflist: bool, fenced: bool, footnotes: bool, hilite: bool, mantitle: bool, math: bool, metadata: bool, no_code_indented: bool, no_intra_emph: bool, strike: bool, super: bool, super_short: bool, tables: bool, tasklist: bool,
+    # oflags/general:
+    no_link: bool, no_rellink: bool, shortlink: bool, skip_html: bool, smarty: bool, standalone: bool,
+    # oflags/gemini:
+    gemini_link_end: bool, gemini_link_in: bool, gemini_link_no_ref: bool, gemini_link_roman: bool, gemini_metadata: bool,
+    # others:
+    maxdepth: Integer) -> String
+
+  def self.into_html: (
+    # feat:
+    attrs: bool, autolink: bool, callouts: bool, commonmark: bool, deflist: bool, fenced: bool, footnotes: bool, hilite: bool, mantitle: bool, math: bool, metadata: bool, no_code_indented: bool, no_intra_emph: bool, strike: bool, super: bool, super_short: bool, tables: bool, tasklist: bool,
+    # oflags/general:
+    no_link: bool, no_rellink: bool, shortlink: bool, skip_html: bool, smarty: bool, standalone: bool,
+    # oflags/html
+    html_callout_mdn: bool, html_callout_gfm: bool, html_custom_attrs: bool, html_escape: bool, html_hard_wrap: bool, html_head_ids: bool, html_num_entity: bool, html_owasp: bool, html_titleblock: bool,
+    # others:
+    maxdepth: Integer) -> String
+
+  def self.into_latex: (
+    # feat:
+    attrs: bool, autolink: bool, callouts: bool, commonmark: bool, deflist: bool, fenced: bool, footnotes: bool, hilite: bool, mantitle: bool, math: bool, metadata: bool, no_code_indented: bool, no_intra_emph: bool, strike: bool, super: bool, super_short: bool, tables: bool, tasklist: bool,
+    # oflags/general:
+    no_link: bool, no_rellink: bool, shortlink: bool, skip_html: bool, smarty: bool, standalone: bool,
+    # oflags/latex:
+    latex_numbered: bool,
+    # others:
+    maxdepth: Integer) -> String
+
+  def self.into_man: (
+    # feat:
+    attrs: bool, autolink: bool, callouts: bool, commonmark: bool, deflist: bool, fenced: bool, footnotes: bool, hilite: bool, mantitle: bool, math: bool, metadata: bool, no_code_indented: bool, no_intra_emph: bool, strike: bool, super: bool, super_short: bool, tables: bool, tasklist: bool,
+    # oflags/general:
+    no_link: bool, no_rellink: bool, shortlink: bool, skip_html: bool, smarty: bool, standalone: bool,
+    # oflags/roff:
+    roff_groff: bool, roff_numbered: bool, roff_manpage: bool, roff_endnotes: bool,
+    # others:
+    maxdepth: Integer) -> String
+
+  def self.into_mdoc: (
+    # feat:
+    attrs: bool, autolink: bool, callouts: bool, commonmark: bool, deflist: bool, fenced: bool, footnotes: bool, hilite: bool, mantitle: bool, math: bool, metadata: bool, no_code_indented: bool, no_intra_emph: bool, strike: bool, super: bool, super_short: bool, tables: bool, tasklist: bool,
+    # oflags/general:
+    no_link: bool, no_rellink: bool, shortlink: bool, skip_html: bool, smarty: bool, standalone: bool,
+    # oflags/roff:
+    roff_groff: bool, roff_numbered: bool, roff_manpage: bool, roff_endnotes: bool,
+    # others:
+    maxdepth: Integer) -> String
+
+  def self.into_ms: (
+    # feat:
+    attrs: bool, autolink: bool, callouts: bool, commonmark: bool, deflist: bool, fenced: bool, footnotes: bool, hilite: bool, mantitle: bool, math: bool, metadata: bool, no_code_indented: bool, no_intra_emph: bool, strike: bool, super: bool, super_short: bool, tables: bool, tasklist: bool,
+    # oflags/general:
+    no_link: bool, no_rellink: bool, shortlink: bool, skip_html: bool, smarty: bool, standalone: bool,
+    # oflags/roff:
+    roff_groff: bool, roff_numbered: bool, roff_manpage: bool, roff_endnotes: bool,
+    # others:
+    maxdepth: Integer) -> String
+
+  def self.into_term: (
+    # feat:
+    attrs: bool, autolink: bool, callouts: bool, commonmark: bool, deflist: bool, fenced: bool, footnotes: bool, hilite: bool, mantitle: bool, math: bool, metadata: bool, no_code_indented: bool, no_intra_emph: bool, strike: bool, super: bool, super_short: bool, tables: bool, tasklist: bool,
+    # oflags/general:
+    no_link: bool, no_rellink: bool, shortlink: bool, skip_html: bool, smarty: bool, standalone: bool,
+    # oflags/term:
+    term_all_meta: bool, term_no_ansi: bool, term_no_colour: bool,
+    # others:
+    maxdepth: Integer) -> String
+
+  def self.into_tree: (
+    # feat:
+    attrs: bool, autolink: bool, callouts: bool, commonmark: bool, deflist: bool, fenced: bool, footnotes: bool, hilite: bool, mantitle: bool, math: bool, metadata: bool, no_code_indented: bool, no_intra_emph: bool, strike: bool, super: bool, super_short: bool, tables: bool, tasklist: bool,
+    # oflags/general:
+    no_link: bool, no_rellink: bool, shortlink: bool, skip_html: bool, smarty: bool, standalone: bool,
+    # others:
+    maxdepth: Integer) -> String
+
+  class Document
+    def parse: (String) -> Ldown::Node
+  end
+
+  class Gemini
+    def render: (Ldown::Node) -> String
+  end
+
+  class HTML
+    def render: (Ldown::Node) -> String
+  end
+
+  class LaTeX
+    def render: (Ldown::Node) -> String
+  end
+
+  class OpenDocument
+    def render: (Ldown::Node) -> String
+  end
+
+  class Roff
+    def render: (Ldown::Node) -> String
+  end
+
+  class Term
+    def render: (Ldown::Node) -> String
+  end
+
+  class Node
+    def diff_from: (Ldown::Node) -> Ldown::Node
+    def tree: (
+      # feat:
+      attrs: bool, autolink: bool, callouts: bool, commonmark: bool, deflist: bool, fenced: bool, footnotes: bool, hilite: bool, mantitle: bool, math: bool, metadata: bool, no_code_indented: bool, no_intra_emph: bool, strike: bool, super: bool, super_short: bool, tables: bool, tasklist: bool,
+      # oflags/general:
+      no_link: bool, no_rellink: bool, shortlink: bool, skip_html: bool, smarty: bool, standalone: bool,
+      # others:
+      maxdepth: Integer) -> String
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: ldown
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- gemmaro
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: This is a Markdown parser and converter library using the lowdown C library.  It
+  can convert into several markup languages, for example, HTML (HTML5), LaTeX, roff
+  (man, mdoc, and ms), the flat OpenDocument (FODT), ANSI compatible UTF-8 terminal
+  (term), Gemtext (for Gemini protocol), and 'tree' for debug purpose.  The input
+  options for Markdown documents include various flavors support, such as GitHub flavored
+  Markdown, experimental CommonMark, and multiple unique features, and so the output
+  options do.
+email:
+- gemmaro.dev@gmail.com
+executables: []
+extensions:
+- ext/ldown/extconf.rb
+extra_rdoc_files: []
+files:
+- ".clang-format"
+- ".dir-locals.el"
+- ".document"
+- ".envrc"
+- ".rdoc_options"
+- CHANGELOG.md
+- COPYING
+- README.md
+- Rakefile
+- ext/ldown/extconf.rb
+- ext/ldown/ldown.c
+- ext/ldown/ldown.h
+- lib/ldown.rb
+- lib/ldown/version.rb
+- sig/ldown.rbs
+homepage: https://codeberg.org/gemmaro/ldown
+licenses: []
+metadata:
+  homepage_uri: https://codeberg.org/gemmaro/ldown
+  source_code_uri: https://codeberg.org/gemmaro/ldown.git
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Markdown parser library with lowdown
+test_files: []