@asciidoctor/core - v4.1.0
    Preparing search index...

    Class SemanticHtml5ConverterExperimental

    A built-in converter that generates HTML 5 output maximizing the use of semantic constructs — <section>, <aside>, <figure>, <nav>, <blockquote>, DPUB-ARIA roles — instead of the AsciiDoc.py-compatible markup produced by the default html5 backend.

    Registered for the semantic-html5 backend:

    const html = await Asciidoctor.convert(input, { backend: 'semantic-html5' })

    This converter is experimental. It is the fast-iteration testbed for the modern HTML output effort started upstream in Asciidoctor's feature/html-converter-next branch (see asciidoctor#242): shipping it here lets the semantic markup decisions be evaluated against real projects and real stylesheets, and the decisions that prove solid are meant to be ported back to the Ruby implementation. Consequences:

    • the emitted markup (elements, class names, structure) and the default stylesheet may change in any release, without being treated as breaking changes — pin an exact version if you depend on the output shape;
    • it is not a candidate to replace the default html5 backend, and the html5 backend's output is not affected in any way;
    • feedback on the element mapping is welcome on the upstream issue.

    The scenario fixtures under test/fixtures/semantic-html5-scenarios/ (shared with the upstream branch) are the source of truth for the emitted markup, and the per-node element mapping and design rationale are documented in devdocs/semantic-html5-converter.adoc.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _decodeDataUri _voidSlash _xmlMode backend readSvgContents

    Accessors

    logger

    Methods

    _formatAuthor _generateAuthors _generateDocumentTitle _generateHeader _generateRevision _generateSectionNumbering _inContext contentOnly convert convert_admonition convert_audio convert_colist convert_dlist convert_document convert_embedded convert_example convert_floating_title convert_image convert_inline_anchor convert_inline_break convert_inline_button convert_inline_callout convert_inline_footnote convert_inline_image convert_inline_indexterm convert_inline_kbd convert_inline_menu convert_inline_quoted convert_listing convert_literal convert_olist convert_open convert_outline convert_page_break convert_paragraph convert_pass convert_preamble convert_quote convert_section convert_sidebar convert_stem convert_table convert_thematic_break convert_toc convert_ulist convert_verse convert_video createLogMessage getLogger handles messageWithContext skip create registerFor

    Constructors

    Properties

    Experimental_decodeDataUri

    _decodeDataUri: (target: any) => any

    Experimental_voidSlash

    _voidSlash: string

    Experimental_xmlMode

    _xmlMode: boolean
    backend: any
    readSvgContents: (node: any, target: any) => Promise<any>

    Accessors

    • get logger(): LoggerLike
      Experimental

      The logger for this converter. The Logging mixin (logging.js) overrides this getter on the instance.

      Returns LoggerLike

    Methods

    _formatAuthor

    _generateAuthors

    _generateDocumentTitle

    _generateHeader

    _generateRevision

    _generateSectionNumbering

    _inContext

    • Experimental

      Convert using only content (no wrapping).

      Parameters

      • node: object

        the node whose content to return

      Returns Promise<string>

    • Experimental

      Convert a node by dispatching to a convert_<transform> method.

      Parameters

      • node: AbstractNode

        the AbstractNode to convert

      • Optionaltransform: string

        hint for which method to call (default: node.nodeName)

      • Optionalopts: object

        optional hints

      Returns unknown

      the result of the convert_<transform> handler; the actual type depends on the implementation

    • Experimental

      Parameters

      • node: any
      • Optionalopts: {}

      Returns Promise<string>

    convert_page_break

    • Experimental

      Alias for messageWithContext (used in extensions).

      Parameters

      • text: any
      • Optionalcontext: {}

      Returns {
          include_location?: any;
          source_location?: any;
          text: string;
          inspect(): string;
          toString(): string;
      }

    • Experimental

      Report whether this converter can handle the given transform.

      Parameters

      • transform: string

        the transform name

      Returns boolean

    • Experimental

      Build an auto-formatting log message that carries structured source_location (rather than baking it into the text), for use with this.logger.warn(...).

      Parameters

      • text: string
      • Optionalcontext: { include_location?: any; source_location?: any }

      Returns {
          include_location?: any;
          source_location?: any;
          text: string;
          inspect(): string;
          toString(): string;
      }

    • Experimental

      Register this converter class with the global registry.

      Parameters

      • ...backends: string[]

        backend names to register for

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    _formatAuthor_generateAuthors_generateDocumentTitle_generateHeader_generateRevision_generateSectionNumbering_inContextcontentOnlyconvertconvert_admonitionconvert_audioconvert_colistconvert_dlistconvert_documentconvert_embeddedconvert_exampleconvert_floating_titleconvert_imageconvert_inline_anchorconvert_inline_breakconvert_inline_buttonconvert_inline_calloutconvert_inline_footnoteconvert_inline_imageconvert_inline_indextermconvert_inline_kbdconvert_inline_menuconvert_inline_quotedconvert_listingconvert_literalconvert_olistconvert_openconvert_outlineconvert_page_breakconvert_paragraphconvert_passconvert_preambleconvert_quoteconvert_sectionconvert_sidebarconvert_stemconvert_tableconvert_thematic_breakconvert_tocconvert_ulistconvert_verseconvert_videocreateLogMessagegetLoggerhandlesmessageWithContextskipcreateregisterFor