HTML Export

core.export.html

Neorg's HTML Exporter

Overview

This module exists as an interface for core.export to export .norg files to HTML. As a user the only reason you would ever have to touch this module is to configure how you'd like your markdown to be exported (i.e. do you want to support certain extensions during the export). To learn more about configuration, consult the relevant section.

Configuration

• extension

  (string)

  Used by the exporter to know what extension to use when creating HTML files. The default is recommended, although you can change it.

  "html"

• link_builders

  (table)

  
  

  • fragment_builder

    (function)

    Function handler for building just the fragment. The fragment is the part of the URL that comes after the "#" and it's used for linking to specific IDs within a file. @param args FragmentArgs @return string

    function(args)

  • link_builder

    (function)

    Function handler for building the entire link. If you change this handler you'll need to change @param link Link @return string

    function(link)

  • path_builder

    (function)

    Function handler for building just the path URL path. @param link Link @return string

    function(link)

• ranged_tag_handler

  (empty list)

  If you'd like to modify the way specific range tabs are handled. For example if you wanted to translate document.meta into use-case specific HTML, you could so here (see: module.private[ranged_tag_handler""] for examples).

Dependencies

• core.esupports.hop - "Hop" between Neorg links, following them with a single keypress.
• core.integrations.treesitter - A module designed to integrate Treesitter into Neorg.